Skip to main content
HeirPros – Heir Search Firm

Errors

For AI agents: a documentation index is available at /llms.txt. This page is also available as markdown.

Errors return JSON with a code and a plain-English message.

Error format

{
  "error": {
    "code": "validation_failed",
    "message": "Some fields are missing or not valid. unknown_heirs: Must be between 1 and 25.",
    "details": [ { "field": "unknown_heirs", "message": "Must be between 1 and 25." } ]
  }
}

details is only present for validation_failed. It lists each field that needs fixing.

Error codes

StatusCodeMeaning
400invalid_jsonThe body is not valid JSON.
401missing_api_key / invalid_api_keyNo API key was sent, or the key is not valid.
405method_not_allowedWrong HTTP method.
413body_too_largeThe body is over 10 KB.
422validation_failedA field is missing or not valid. The message names each field.
503not_configuredThe API is temporarily unavailable.

Retrying

Fix the request before retrying a 4xx error. A 503 can be retried after a short wait.