Errors

Herald uses HTTP response status codes to indicate the success or failure of an API request.

• Codes in the [.h-code]2xx[.h-code] range indicate success.
• Codes in the [.h-code]4xx[.h-code] range indicate an error that failed given the information provided.
• Codes in the [.h-code]5xx[.h-code] range are rare and indicate an error with Herald.

For failed requests (codes in the [.h-code]4xx[.h-code] or [.h-code]5xx[.h-code] range), Herald will send back an array of error objects. This array of error objects will contain all known errors for the most relevant HTTP status code.

HTTP status codes

Error schema

[.icon-circle-blue][.icon-circle-blue] See our full [.h-endpoint-link]error schema[.h-endpoint-link] in our API reference.

Example:

Copied

{
    "errors": [
        {
            "id": "a328ffb9-631a-4c21-9d4e-9f3a213b7bcd",
            "code": "invalid_format",
            "message": "\"risk_values[2].value.postal_code\" length must be 5 characters long",
            "display_message": "length must be 5 characters long",
            "path": "risk_values[2].value.postal_code"
        }
    ]
}
 

Error codes

‍