API Reference
REST APIs built for production
Simple, predictable endpoints for tokenization, detokenization, and vault operations. Designed for low-latency application calls with consistent request and response formats.
Core API
Five endpoints. Everything you need.
Not dozens of sprawling routes. A small, deliberate set of endpoints covers the entire vault lifecycle.
- POST
Tokenize sensitive data
Replace values with format-preserving tokens ready for storage, AI prompts, and logs.
/v1/tokenize
- GET
Health Check
Confirm the vault and your credentials are live before routing production traffic.
/v1/health
- GET
Policy Management
Read and manage which fields and services can see which tokenized fields.
/v1/policies
- POST
Detokenize protected values
Restore a token to its original value, scoped by policy and access rules.
/v1/detokenize
- POST
Mask protected values
Return a display-safe view of a token for UI or logs, scoped by policy and access rules.
/v1/mask
Reference goes deep
Documented down to the request
Request signatures- Request & response examples
- Authentication
- Error codes
- Example cURL requests
cURL
curl -sS -X POST "http://localhost:8080/api/v1/tokenize" \
-H "Content-Type: application/json" \
-d '{
"data": {
"ssn": "078-05-1120",
"credit_card": "4532-9012-8812-4019",
"phone": "+1-415-555-0198"
}
}'
Start calling the API
Predictable endpoints. Production from day one.
Every endpoint is typed, versioned, and guards sensitive data, from authentication to error responses.