{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-@l10n/it/products/namirialnotify/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Error handling","description":"Integration and usage documentation."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"error-handling","__idx":0},"children":["Error handling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Namirial Notify APIs do not all expose the same error payload shape. When"," ","building a production integration, handle errors in two"," ","layers:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["First, branch on the HTTP status code."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Then, parse the service-specific error body when one is available."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this guide as the shared reference for error behavior across these APIs."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-http-status-codes","__idx":1},"children":["Common HTTP status codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These are the response codes explicitly documented across the EviMail, EviSMS,"," ","EviNotice, and EviPost API references."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning in the current docs"},"children":["Meaning in the current docs"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Where it appears"},"children":["Where it appears"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request was accepted or the resource was returned successfully."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All documented APIs"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An idempotent replay returned the cached body of a previous ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}," Submit request."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EviMail Submit, EviSMS Submit, EviNotice Submit, EviPost Submit"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The endpoint is valid, but there is no downloadable content yet."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EviNotice attachment and affidavit downloads"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request is invalid, incomplete, or fails a business rule."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EviMail Submit/AffidavitRequest, EviSMS Submit, EviNotice Submit/Get/Query, EviPost Submit, Query, Cancel and AffidavitRequest"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All documented APIs"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The authenticated account is not provisioned for the requested service, lacks required API permissions, or has attempted a disallowed operation (such as specifying a restricted ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["From"]}," address or setting an internal header)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EviPost Submit, Query, Cancel and AffidavitRequest; EviMail Submit; EviNotice Submit, Query, affidavit downloads and AffidavitRequest"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The requested resource was not found."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EviNotice Get, attachments ZIP, single affidavit and AffidavitRequest (affidavits ZIP uses 403); EviPost Cancel"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["405 Method Not Allowed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Requested functionality is disabled or unsupported for this notice."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EviNotice Submit and AffidavitRequest"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409 Conflict"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A concurrent Submit request is already in flight with the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyToken"]},". Back off and retry with the same token."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EviMail Submit, EviSMS Submit, EviNotice Submit, EviPost Submit"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["492"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The submission quota for this recipient or for this service type on your site was reached. Avoid retrying immediately; contact support if it persists."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["EviPost Submit"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the operation list above for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409"]}," applies to all Submit endpoints when idempotency is in use — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#idempotency-signals"},"children":["Idempotency signals"]}," below. No single cross-service contract is defined for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5xx"]}," responses — validate those with your Namirial Notify contact before you depend on them."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-body-formats-by-service","__idx":2},"children":["Error body formats by service"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"evinotice","__idx":3},"children":["EviNotice"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The EviNotice Submit endpoint documents an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/problem+json"]}," payload"," ","with these fields:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP status code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URI identifying the problem type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Title"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Short summary of the error"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Detail"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human-readable explanation"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Instance"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URI reference identifying the specific occurrence of the problem. May be absent."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request identifier for support and troubleshooting"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["InvalidValues"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of field-level validation errors, each describing a field path and the reason it failed. Present on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," validation errors."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the most explicit error contract in this API set."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"evimail","__idx":4},"children":["EviMail"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Single-message EviMail operations use the v1 service-style error payload:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus.errorCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service-specific error code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus.message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Main error message"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus.errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional array of field-level or validation details"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Parse ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," for v1 EviMail service errors. The v2 EviMail batch operations can return Problem Details responses. For example, recipient CSV validation returns HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," with a problem description. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/apis/evimail-api#add-batch-recipients"},"children":["EviMail batch API"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"evisms","__idx":5},"children":["EviSMS"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The EviSMS OpenAPI specification defines a legacy service-style error payload:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus.errorCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service-specific error code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus.message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Main error message"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus.errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional array of field-level or validation details"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"evipost","__idx":6},"children":["EviPost"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviPost is a V1 service and uses the same service-style error payload as EviMail and EviSMS:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus.errorCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Service-specific error code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus.message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Main error message"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus.errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional array of field-level or validation details"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Parse ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," for all EviPost error responses."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"evisign","__idx":7},"children":["EviSign"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviSign’s v1 issuer operations return errors with a camelCase ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," envelope. Use the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/apis/evisign-api#response-formats-and-errors"},"children":["EviSign API error table"]}," for operation-specific status codes. For Cancel and Resend, a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}," can also indicate that the authenticated caller does not own the EviSign."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviSign Bundle uses the v2 Problem Details response format. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/apis/evisign-signlink#http-responses-and-errors"},"children":["SignLink"]}," runs on the application host and has its own error format. Use its HTTP status for client branching."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"idempotency-signals","__idx":8},"children":["Idempotency signals"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All four Submit endpoints support the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyToken"]}," request header. When present, the server echoes back an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyStatus"]}," response header:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"X-Evi-IdempotencyStatus"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyStatus"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP status"},"children":["HTTP status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["New"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First time this token is seen. The request executed normally."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Replay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The token matched a cached ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}," submission. The original response body is returned. The message is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," resubmitted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Conflict"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409 Conflict"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Another Submit with the same token is currently in flight. Back off and retry with the same token."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Responses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["408"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5xx"]}," are not cached — a request that results in one of these codes re-executes regardless of the token."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recommended-client-behavior","__idx":9},"children":["Recommended client behavior"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"on-400-bad-request","__idx":10},"children":["On ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Treat the request as invalid until you have reviewed the payload."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log the endpoint, the request identifier if present, and the parsed error"," ","fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Do not blindly retry the same payload. Fix validation or business-rule issues"," ","first."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"on-401-unauthorized","__idx":11},"children":["On ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Verify that you are using the right environment base URL."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Verify that the credentials match the environment and enabled services for"," ","your organisation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fail fast and alert operations rather than retrying continuously."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"on-404-not-found","__idx":12},"children":["On ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Handle it as a normal integration case when retrieving a known resource."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Confirm that you are querying with the right ID and against the right"," ","environment."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"production-recommendations","__idx":13},"children":["Production recommendations"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Parse the JSON body when present, but always preserve the raw HTTP status"," ","code in logs and telemetry."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Do not hard-code logic against a single error message string."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Treat ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Instance"]},", and similar identifiers as support artifacts"," ","worth capturing."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Normalize the different service-specific payloads in your own client layer so"," ","downstream systems receive a consistent internal error object."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":14},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/apis/overview"},"children":["API reference overview"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/dev/integration-patterns"},"children":["Integration workflows"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/dev/security-best-practices"},"children":["Security and authentication"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/apis/evimail-api"},"children":["EviMail API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/apis/evisms-api"},"children":["EviSMS API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/apis/evinotice-api"},"children":["EviNotice API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/it/products/namirialnotify/apis/evipost-api"},"children":["EviPost API"]}]}]}]},"headings":[{"value":"Error handling","id":"error-handling","depth":1},{"value":"Common HTTP status codes","id":"common-http-status-codes","depth":2},{"value":"Error body formats by service","id":"error-body-formats-by-service","depth":2},{"value":"EviNotice","id":"evinotice","depth":3},{"value":"EviMail","id":"evimail","depth":3},{"value":"EviSMS","id":"evisms","depth":3},{"value":"EviPost","id":"evipost","depth":3},{"value":"EviSign","id":"evisign","depth":3},{"value":"Idempotency signals","id":"idempotency-signals","depth":2},{"value":"Recommended client behavior","id":"recommended-client-behavior","depth":2},{"value":"On 400 Bad Request","id":"on-400-bad-request","depth":3},{"value":"On 401 Unauthorized","id":"on-401-unauthorized","depth":3},{"value":"On 404 Not Found","id":"on-404-not-found","depth":3},{"value":"Production recommendations","id":"production-recommendations","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"title":"Error handling","description":"Common HTTP status codes, error payload patterns, and client-side handling guidance for the Namirial Notify APIs.","layout":"doc","outline":"deep","keywords":["error handling","api errors","http status codes","problem json","namirial notify api"],"seo":{"title":"Error handling"}},"lastModified":"2026-11-18T15:36:25.000Z","isTranslationFallback":true,"pagePropGetterError":{"message":"","name":""}},"slug":"/it/products/namirialnotify/dev/error-handling","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}