{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-developer-resources/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["json-schema"]},"type":"markdown"},"seo":{"title":"Error Reference","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"error-reference","__idx":0},"children":["Error Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All our APIs return errors following ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://www.rfc-editor.org/rfc/rfc9457.html"},"children":["RFC 9457 (Problem Details for HTTP APIs)"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-response-structure","__idx":1},"children":["Error Response Structure"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../@latest/openapi.yaml#/components/schemas/Atlas.Errors.ProblemDetails"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/Atlas.Errors.ProblemDetails"},"Atlas.Errors.DetailedError":{"type":"object","required":["code","detail","param"],"properties":{"code":{"type":"string","description":"A stable, machine-readable error code (and translation key).\ne.g., \"error.email.required\""},"detail":{"type":"string","description":"The final, translated, human-readable message for this specific failure."},"param":{"type":"string","format":"json-pointer","description":"The specific JSON path that caused the error.\ne.g., \"/email\""}},"description":"A detailed, machine-readable validation error.\nThis corresponds to the `finalDetailedError` in the Go package."},"Atlas.Errors.ProblemDetails":{"type":"object","required":["type","title","status"],"properties":{"type":{"type":"string","format":"uri","description":"A URI reference that identifies the problem type.\nThis MUST link to public documentation.\ne.g., \"https://developer-next.ingrid.com/errors/validation-error\""},"title":{"type":"string","description":"A short, human-readable summary of the problem type (translated).\ne.g., \"Validation Failed\""},"status":{"type":"integer","format":"int32","description":"The HTTP status code.\ne.g., 400"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence (translated).\ne.g., \"One or more fields failed validation.\""},"instance":{"type":"string","format":"uri","description":"A unique identifier for the request that caused the error. Typically to be\nshared with Ingrid support for debugging.","examples":["urn:ingrid:request:f47ac10b-58cc-4372-a567-0e02b2c3d479"]},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Atlas.Errors.DetailedError"},"description":"An array of detailed validation errors.\nThis is omitted if not applicable."}},"description":"The standard, RFC 9457-compliant error response for our B2B APIs.\nThis corresponds to the `finalProblemDetails` in the Go package."}}}},"schemaResolvedErrors":[]},"children":[]}]},"headings":[{"value":"Error Reference","id":"error-reference","depth":1},{"value":"Error Response Structure","id":"error-response-structure","depth":2}],"frontmatter":{"title":"Error Reference","description":"RFC 9457 compliant error types for our APIs","seo":{"title":"Error Reference"}},"lastModified":"2026-02-24T19:14:57.408Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-resources/ingrid-api/errors","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}