Masking Errors
Common error messages from the Mask API, what causes them, and how to fix them.
The Mask API returns structured error messages for invalid requests.
Endpoint: PUT {baseurl}/api/vault/mask
Successful empty-string passthrough
An explicitly supplied empty string is passed through unchanged successfully.
Request:
{
"mask": [{"value": "", "token_name": "Text Token"}]
}
The Mask API returns the empty string unchanged. This differs from a request where the value field is absent, which returns Missing value, and from an empty mask array, which returns Payload is empty.
Common errors
| Scenario | Error message |
|---|---|
| Empty payload | Payload is empty |
Missing mask key | mask data missing |
Missing value | Missing value when the value field is absent, not when its string is empty |
Missing token_name | Missing token_name |
Invalid token_name | token_name not defined: {<INVALID_TOKEN_NAME>} |
Missing format | Missing format |
Invalid format | format name not defined: {<INVALID_FORMAT_NAME>} |
| Missing metadata | Token and Format Metadata not available |
| Trial quota exceeded | You have exceeded the maximum number of token creation limit for your trial subscription |
| Value too large | Masked data exceeds the approved limit of 600 characters |
| Processing failure | Masking failed after 3 retries |
Example: Missing token_name
Request:
{
"mask": [
{ "value": "George Williams", "token_name": "" }
]
}
Response:
{
"data": null,
"success": false,
"error": { "message": "Missing token_name" }
}
Fixes
Was this page helpful?