Client integration documentation
Errors
Handle HTTP/API errors separately from XML application and result codes.
HTTP errors
| HTTP | Error | Typical cause |
|---|---|---|
| 400 | invalid_request / invalid_xml | Invalid request format, XML, query parameters, or token. |
| 401 | unauthorized | Client ID or authentication failure. |
| 403 | unauthorized / forbidden / invalid_results_token | Access denied or result token is invalid for the authenticated client. |
| 404 | not_found | Unknown API route. |
| 410 | results_token_expired | The returned results token has expired. |
| 413 | request_too_large / invalid_request | Request body exceeds the permitted size. |
| 415 | unsupported_media_type | Unsupported POST content type. |
| 429 | rate_limited | Request rate or quota exceeded. |
| 500 | internal_error | Unexpected API processing error. |
| 502 | bad_gateway | Temporary gateway or upstream response failure. |
| 503 | service_unavailable | Service temporarily unavailable. |
Request IDs
API responses may include an X-AC-Request-ID header and error bodies may include request_id. Include the request ID when reporting an integration problem to Authorised Compliance.