Skip to content
Developers

Errors

Every error has the same body.

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is not valid.",
    "fields": null
  }
}

Use code in your code. message is for people and may change. fields lists messages per field on validation_error.

Codes

CodeStatus
validation_error400
invalid_api_key401
api_key_expired401
account_not_approved403
account_suspended403
service_not_enabled403
permission_denied403
not_found404
method_not_allowed405
idempotency_conflict409
in_progress409
payload_too_large413
unsupported_media_type415
mvr_state_unavailable422
rate_limited429
internal_error500
rate_limit_unavailable503
price_unavailable503

payload_too_large is a POST over 32 MB. unsupported_media_type is a POST that isn't multipart. rate_limited and rate_limit_unavailable come with Retry-After.

A missing SSN with CDLIS is a validation_error on ssn. The order codes are explained in Orders.