Errors
Learn about our response and error codes.
ComplyCube uses standard HTTP response codes to indicate the success or failure of an API request.
Codes in the 2xx
range indicate success. Codes in the 4xx
range indicate an error that failed given the information provided. Codes in the 5xx
range indicate an error with ComplyCube's servers.
Some 4xx
errors include an error code that briefly explains why the error occurred.
HTTP Response Codes
Code | Description |
| Everything worked as expected. |
| The resource is deleted. |
| The request has missing arguments or is malformed. See examples of these type of errors. |
| The request is not authenticated. |
| The request is authenticated but does not have sufficient permissions. |
| The resource requested does not exist. |
| The request is too large. |
| A processing error has occurred. |
| The rate limit or service quota has been breached. |
| Something is wrong on our end. Subscribe to our status page to be notified of any incident. |
Processing Errors
Error | Description |
| Returned when only one side of a supported document type is provided before running a check. Applies to Document Check. |
| Returned when an unsupported document attachment format is provided before running a check. Applies to Document Check. |
| Returned when a check is run against an unsupported ID type and country combination.
Applies to Document Check. |
| Returned when a check is run against a document with a missing Applies to Document Check. |
| Returned when an unsupported document type is checked. It could also be returned when the image quality is not adequate for the document to be recognised. Applies to Document Check. |
| Returned when ComplyCube is not able to read data from a document image. This may occur when the image is of low quality or is incorrectly oriented. Applies to Document Check. |
| Returned when a live photo is deemed likely as spoofed, i.e. not live. It could also be returned when the image quality is not adequate for the liveness to be established. Applies to Live Photo. |
| Returned when an invalid image format is provided. Applies to Live Photo, Identity Check and Document Check. |
| Returned when multiple faces are detected. The client must retake the live photo. Applies to Live Photo. |
| Returned when no faces are detected. The client must retake the live photo. Applies to Live Photo. |
| Returned when facial features are obstructed. The client must retake the live photo. Applies to Live Photo. |
| Returned when eyes are closed. Applies to Live Photo. |
| Returned when the face is not straight. Applies to Live Photo. |
| Returned when excessive glare is detected. Applies to Live Photo. |
| Returned when the image is dark. Applies to Live Photo. |
| Returned when blur is detected. Applies to Live Photo. |
| Returned when the image provided is too large. Applies to Document, Live Photo, Identity Check and Document Check. |
Example of Standard Errors
Below you will find some example error responses from the ComplyCube API.
Forbidden
You'll most likely receive a 401: Unauthorized
response when you provide an invalid API key.
Bad Request
You'll get a 400: Bad Request
when you fail validation.
Not Found
When a resource is not found, you will get a 404: Not Found
response.
Rate Limited
You will receive a 429: Too Many Requests
response when you make too many requests.
Internal Server Error
You'll receive a 500: Internal Server Error
response when something goes wrong on our side.
Last updated