API Response codes

Veridion APIs use standard HTTP response codes to indicate various classes of success or error responses. Below is a list of the codes returned by our APIs.


HTTP Status

Description

200 OK

Standard HTTP successful response.

202 Accepted

The request was acknowledged and processed but no response was available. The caller should retry the request later.

400 Bad Request

Standard HTTP invalid request response.

The request body does not match the expected schema or invalid parameters were passed. Check the error response message field for additional information.

401 Unauthorized

Standard HTTP unauthorized access response.

Authentication is invalid. Check if the x-api-key header is passed correctly. Read more on Authenticating Requests.

403 Forbidden

Standard HTTP forbidden access response.

API Quotas were reached or you don't have enough permissions to access the requested resource. Please contact technical support for more information.

422 Unprocessable Entity

Standard HTTP response.

Indicates that the server understands the request but cannot process it due to semantic errors. Returned when the request is syntactically correct but contains invalid or logically incorrect data.

429 Too Many Requests

Standard HTTP response for exceeding rate limits.

Please wait for a few seconds and then retry the request. Read more on Rate Limiting.

500 Internal Server Error

Standard HTTP response for an unexpected error that occurred on our server.

Please retry the request or contact technical support if the error persists.

503 Service Unavailable

Standard HTTP service unavailable response, indicating that the server is temporarily unable to handle the request.

Please retry the request or contact technical support if the error persists.

504 Gateway timeout

Standard HTTP response for server timeout when attempting to complete the request.

Please retry the request or contact technical support if the error persists.