Documentation menu
ErrorResponse
Fields, types and constraints for the ErrorResponse public API model.
Machine-readable error envelope used by public API failures.
Fields
| Field | Type | Constraint | Example | Visibility |
|---|---|---|---|---|
status *Whether the operation completed successfully. | boolean | — | false | Public contract |
code *Stable code for programmatic error handling. | string | enum: validation_error | missing_api_key | invalid_api_key | inactive_account | unapproved_account | access_restricted | source_scope | page_size_limit | daily_limit | monthly_limit | rate_limit_exceeded | service_unavailable | internal_error | "validation_error" | Public contract |
message *Human-readable status or error message. | string | — | "example" | Public contract |
detailsField-level validation details. | object[] | — | [] | Public contract |
Machine-readable schema
The model is published under the same name in the JSON Schema bundle.
JSON SchemaDecision boundary
An API result is a candidate match. A final sanctions or compliance decision requires official-source verification and human review.