Thanks! Someone from our team will reach out to you soon.
Oops! Something went wrong while submitting the form.
Learn more about error codes and how to resolve them.
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
Everything worked as expected.
400 (Bad Request)
The format or content of your request is invalid.
No valid API key provided.
404 (Not Found)
The resource doesn't exist.
429 (Too Many Requests)
Too many requests hit the API too quickly. Our current limits in both Sandbox and Production are 120 requests per minute.
500 (Server Error)
Something went wrong with Herald.
[.icon-circle-blue][.icon-circle-blue] See our full [.h-endpoint-link]error schema[.h-endpoint-link] in our API reference.
Details about the specific manifestation of the error.
A user-friendly representation of what caused the error, safe to be formatted on a front-end. Currently only includes a value for errors caused by risk and coverage parameters.
length must be 5 characters long
If the error is parameter-specific, included a path to the specific parameter. Useful for rendering error messages below inputs on the front end. Only includes a value for errors causes by risk and coverage parameters.
"message": "\"risk_values.value.postal_code\" length must be 5 characters long",
"display_message": "length must be 5 characters long",
Request was made over http instead of https.
An invalid HTTP method was used for the path provided.