Unmasking Errors
All error responses and HTTP status codes for the Protecto Unmasking API.
The Unmasking API returns two distinct error response formats depending on the error type:
- Application errors — return
success,data, anderror.message - Authentication errors — return a
detailfield
Application error format
{
"data": null,
"success": false,
"error": {
"message": "Payload is empty"
}
}
Authentication error format
{
"detail": "Not authenticated"
}
Error messages by category
| HTTP status | Error message | When it occurs |
|---|---|---|
| 500 | Payload is empty | Payload is empty or unmask array contains empty objects |
| 500 | unmask data missing | The unmask key is missing from the request |
| 500 | Missing token value field | token_value field is not present in an unmask object |
| 500 | Missing token value | token_value field is present but empty |
Retry behavior
| HTTP status | Scenario | Recommended action |
|---|---|---|
| 500 | Payload or operation failure | Fix the request or retry with backoff |
| 401 | Authentication or license issue | Refresh token or contact help@protecto.ai |
Unmasking is deterministic. Retrying the same request with the same token values does not change the stored token state.
Security considerations
- Log error messages carefully to avoid leaking sensitive information in error outputs
- Tightly control and audit access to unmasking endpoints
401errors indicate the token is invalid or expired — rotate tokens promptly
Was this page helpful?
Last updated 3 weeks ago
Built with Documentation.AI