Skip to main content

​
Response envelope

All errors return the same top-level shape. type, code, message, status, and doc_url are always present. 
{
  "error": {
    "type": "invalid_request_error",
    "code": "CLAIM_NOT_FOUND",
    "message": "No claim with id abc123",
    "status": 404,
    "doc_url": "https://done.mintlify.app/errors/claim-not-found"
  }
}
Validation errors add a details array. Server errors add a request_id you can share with support.

​
Error types

TypeWhen
invalid_request_errorThe request was malformed or referenced a resource that doesn’t exist. Fix the request before retrying.
authentication_errorThe Authorization header is missing, malformed, or the token is not recognised.
api_errorAn unexpected server-side failure. Retry with exponential back-off. If it persists, contact support with the request_id.

​
Error codes

CodeStatusTypeDescription
VALIDATION_ERROR400invalid_request_errorBody, query, or path params failed schema validation.
TOKEN_INVALID401authentication_errorToken missing, malformed, or not recognised.
SCHEMA_NOT_FOUND404invalid_request_errorSchema id not found or belongs to a different user.
CLAIM_NOT_FOUND404invalid_request_errorClaim id not found or belongs to a different user.
CUSTOMER_NOT_FOUND404invalid_request_errorCustomer id not found or belongs to a different user.
CUSTOMER_EXTERNAL_ID_CONFLICT409invalid_request_errorexternal_id already exists for this account.
CLAIM_NOT_OPEN422invalid_request_errorEvent submitted to a claim whose status is not OPEN.
INTERNAL_ERROR500api_errorUnexpected server error.