HTTP Response Codes

We use conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing, a job could not be found), and codes in the 5xx range indicate an error with our servers.

Success Responses

HTTP Response Code Description
200 OK The request was successful.
201 CREATED The request has been fulfilled, resulting in the creation of a new resource. Used for most POST requests.
202 ACCEPTED The request has been accepted for processing. Ex. Used with background checks where the order has been received but not completed yet.
204 NO CONTENT The server successfully processed the request, and is not returning any content. Used for most DELETE requests.
207 MULTI-STATUS A batch request was successfully processed.

Error Responses

HTTP Response Code Description
400 BAD REQUEST Default response code for a request failure due to an apparent client error.
401 UNAUTHORIZED The request was refused because authentication either failed or was not provided.
403 FORBIDDEN The request was refused because the provided authorization credentials do not grant sufficient privileges.
404 NOT FOUND The resource could not be found.
408 REQUEST TIMEOUT The server timed out waiting for the request. By default, requests time out after 60 seconds.
409 CONFLICT The request could not be processed because of conflict in the current state of the resource. Ex. Used with application files where more than one file of the same type is not allowed.
413 PAYLOAD TOO LARGE The request could not be processed because the payload was too large. Used for batch requests that include over 100 requests.
415 UNSUPPORTED MEDIA TYPE The request could not be processed because a Content-Type other than JSON was requested.
422 UNPROCESSABLE The request was unable to be processed because it contains invalid parameters. The response will contain a JSON object containing one or more errors relating to the invalid parameters.
424 FAILED DEPENDENCY The request failed because it depended on another request that failed.
429 TOO MANY REQUESTS You’ve exceeded your rate limits. By default you are allowed one request per second, but can burst up to 100 requests within a 60 second window. Your code should stop making API requests temporarily when encountering such a response.
500 SERVER ERROR The request was unable to be processed due to an internal error with our servers.