Errors always use one envelope:
JSON
{
"error": {
"code": "NOT_FOUND",
"message": "User not found",
"request_id": "req_01J..."
}
}| HTTP | code | meaning |
|---|---|---|
| 400 | INVALID_REQUEST | malformed body or parameters; details lists the fields |
| 401 | UNAUTHORIZED | missing, revoked, or unknown API key |
| 403 | FORBIDDEN | key lacks the scope, or the client is outside the key's access |
| 403 | FEATURE_DISABLED | the feature (for example Dark Web Monitoring) is not enabled for this client |
| 404 | NOT_FOUND | no such object within the key's access |
| 409 | CONFLICT | the object already exists (for example a user with that email) |
| 429 | RATE_LIMITED | slow down; see Retry-After |
| 500 | INTERNAL_ERROR | our fault; include request_id when you contact us |
Request ids
Every response carries X-Request-Id. Quote it when reporting a problem.