The API uses conventional HTTP response codes to indicate the success or failure of an API request. A 200 means there was a matching person returned, a 404 means that a matching person was not found or returned, any 4xx besides 404 indicates an issue with the request, and 5xx errors indicate an internal issue with the API.

4xx Response Fields

Field NameTypeDescription
errorobjectObject containing the error type message
statusintegerHTTP Status Code

Example 404 Response

    "status": 404,
    "error": {
        "type": "not_found",
        "message": "No records were found matching your request"

Example 429 Response

    "status": 429,
    "error": {
        "type": "rate_limit_error",
        "message": "An error occurred due to requests hitting the API too quick"

Error codes

StatusError Name                            Description
400invalid_request_errorRequest contained either missing or invalid parameters
401authentication_errorRequest contained a missing or invalid key
402payment_requiredYou have hit your account maximum (all matches used)
404not_found No records were found matching your request
405invalid_request_error Request method is not allowed on the requested resource
429rate_limit_error An error occurred due to requests hitting the API too quick
5xxapi_error The server encountered an unexpected condition which prevented it from fulfilling the request

Did this page help you?