{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/namirialnotify/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"EviPost","description":"Integration and usage documentation.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"evipost","__idx":0},"children":["EviPost"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviPost is the Namirial Notify service for sending certified physical postal communications — the digital equivalent of a burofax. The document is physically printed and delivered to the recipient's address by the postal operator, with each step in the postal process recorded as evidence and optionally generating a signed affidavit."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the API reference, see the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evipost-api"},"children":["EviPost API"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"when-to-use-evipost","__idx":1},"children":["When to use EviPost"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use EviPost when:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Physical delivery is required or preferred"]}," — the recipient must receive a printed, sealed document at their postal address."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["You need legally binding evidence of physical delivery"]}," — the postal operator reports delivery outcomes that feed into certified affidavits."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The communication cannot be sent digitally"]}," — for jurisdictions or situations where certified physical mail (burofax equivalent) carries specific legal weight."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evimail"},"children":["EviMail"]}," when certified delivery via email is sufficient. Use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evinotice"},"children":["EviNotice"]}," when you need a hosted digital notice with recipient authentication and commitment workflows. Use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evisms"},"children":["EviSMS"]}," for certified mobile delivery."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[":::warning Timeline expectation"," ","EviPost operates on postal timelines — days or weeks, not minutes. Design your integration to accommodate asynchronous state updates driven by postal operator events rather than immediate confirmation."," ",":::"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-evipost-works","__idx":2},"children":["How EviPost works"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"lifecycle-overview","__idx":3},"children":["Lifecycle overview"]},{"$$mdtype":"Tag","name":"Mermaid","attributes":{"data-language":"mermaid","diagramSource":"%%{init: {'theme': 'base', 'themeVariables': {'primaryColor': '#E4F2F2', 'primaryBorderColor': '#006660', 'primaryTextColor': '#0A1111', 'lineColor': '#047C76', 'secondaryColor': '#CDDBDB', 'tertiaryColor': '#f5fafa', 'edgeLabelBackground': '#f5fafa', 'transitionColor': '#047C76'}}}%%\nstateDiagram-v2\n [*] --> Submitted : Submit accepted\n Submitted --> Processed : Document validated, dispatched to postal operator\n Submitted --> Closed : Invalid document (Failed)\n Processed --> Dispatched : Postal operator acknowledged\n Dispatched --> Issued : Courier collected the item\n Issued --> Sent : Item in transit\n Dispatched --> Sent : Item in transit (direct)\n Sent --> Delivered : Delivered to recipient\n Sent --> Undelivered : Delivery not possible\n Undelivered --> Disposed : Item disposed after failed delivery\n Sent --> Failed : Postal operator reported failure\n Delivered --> Closed : Lifecycle complete\n Undelivered --> Closed : Lifecycle complete\n Disposed --> Closed : Lifecycle complete\n Failed --> Closed : Lifecycle complete\n Dispatched --> Cancelled : Cancelled by issuer\n Issued --> Cancelled : Cancelled by issuer\n Sent --> Cancelled : Cancelled by issuer\n Cancelled --> Closed : Lifecycle complete\n","diagramHtml":"

Submit accepted

Document validated, dispatched to postal operator

Invalid document (Failed)

Postal operator acknowledged

Courier collected the item

Item in transit

Item in transit (direct)

Delivered to recipient

Delivery not possible

Item disposed after failed delivery

Postal operator reported failure

Lifecycle complete

Lifecycle complete

Lifecycle complete

Lifecycle complete

Cancelled by issuer

Cancelled by issuer

Cancelled by issuer

Lifecycle complete

Submitted

Processed

Closed

Dispatched

Issued

Sent

Delivered

Undelivered

Disposed

Failed

Cancelled

"},"children":["%%{init: {'theme': 'base', 'themeVariables': {'primaryColor': '#E4F2F2', 'primaryBorderColor': '#006660', 'primaryTextColor': '#0A1111', 'lineColor': '#047C76', 'secondaryColor': '#CDDBDB', 'tertiaryColor': '#f5fafa', 'edgeLabelBackground': '#f5fafa', 'transitionColor': '#047C76'}}}%%\nstateDiagram-v2\n [*] --> Submitted : Submit accepted\n Submitted --> Processed : Document validated, dispatched to postal operator\n Submitted --> Closed : Invalid document (Failed)\n Processed --> Dispatched : Postal operator acknowledged\n Dispatched --> Issued : Courier collected the item\n Issued --> Sent : Item in transit\n Dispatched --> Sent : Item in transit (direct)\n Sent --> Delivered : Delivered to recipient\n Sent --> Undelivered : Delivery not possible\n Undelivered --> Disposed : Item disposed after failed delivery\n Sent --> Failed : Postal operator reported failure\n Delivered --> Closed : Lifecycle complete\n Undelivered --> Closed : Lifecycle complete\n Disposed --> Closed : Lifecycle complete\n Failed --> Closed : Lifecycle complete\n Dispatched --> Cancelled : Cancelled by issuer\n Issued --> Cancelled : Cancelled by issuer\n Sent --> Cancelled : Cancelled by issuer\n Cancelled --> Closed : Lifecycle complete\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-state-transitions","__idx":4},"children":["Key state transitions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Submitted → Processed"]}," — Namirial Notify validates the document (PDF format and page count), certifies it, and dispatches a send request to the postal operator. If the document is invalid or the page count exceeds the subscribed tier, the communication closes immediately as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Processed → Dispatched"]}," — The postal operator acknowledged receipt of the item."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Dispatched → Issued"]}," — The courier collected the item for physical delivery. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Issued"]}," is an operator-reported intermediate state; not all operators or service profiles report it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Issued / Dispatched → Sent"]}," — The item is in transit with the postal operator or courier."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sent → Delivered"]}," — The item was successfully delivered to the recipient. For registered post (burofax), this requires the recipient to sign for delivery."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sent → Undelivered"]}," — The postal operator could not complete delivery. The item may be held at a post office or returned."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Undelivered → Disposed"]}," — The item was disposed of after the retention period at the post office expired."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Any state → Cancelled"]}," — The issuer explicitly cancelled the communication via the platform before delivery was completed."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"submit-a-certified-postal-communication","__idx":5},"children":["Submit a certified postal communication"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /v1/EviPost/Submit\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"uniqueId\": \"...\" }"]}," on success. Note that ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uniqueId"]}," is camelCase, consistent with the other v1 services — the equivalent field in EviMail and EviSMS is named ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eviId"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"required-fields","__idx":6},"children":["Required 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":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Document"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The letter or document to be sent, base64-encoded PDF."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientAddress"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Physical delivery address. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#address-fields"},"children":["Address fields"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"optional-fields","__idx":7},"children":["Optional fields"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientName"]}]}," — display name of the recipient."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientLegalName"]}]}," — legal name of the recipient, recorded in the certification evidence."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]}]}," — display name of the sender."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerLegalName"]}]}," — legal name of the sender, recorded in the evidence."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerAddress"]}]}," — return address for the sender. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#address-fields"},"children":["Address fields"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]}," — processing and certification settings. When omitted, platform defaults apply. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#options"},"children":["Options"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]}]}," — your own correlation key, filterable in Query."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientPhone"]}]}," — recipient's mobile number."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientEmail"]}]}," — recipient's email address."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerPhone"]}]}," — sender's phone number."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerEmail"]}]}," — sender's email address."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerComments"]}]}," — additional comments from the sender, included in the evidence."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"address-fields","__idx":8},"children":["Address fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientAddress"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerAddress"]}," use the same structure:"]},{"$$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":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["StreetAddress"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Street name and number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostalCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Postal code."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Locality"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["City or town."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Country"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO 3166-1 alpha-2 country code (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ES"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Region"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Province or region."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostOfficeBoxAddress"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Post office box address, if applicable."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"options","__idx":9},"children":["Options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All processing and certification configuration lives inside the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}," object."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every field in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}," is optional at the API level. When you omit one, the platform applies a default (noted per field below) — for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceType"]}," becomes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Language"]}," follows your site's configured language, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitProfile"]}," is inferred from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlMethod"]}," follows the account's configured default method. The web portal's submission form presents these same settings with a default already selected, so a value is always recorded whichever channel you use. The few genuinely conditional requirements — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceProfile"]}," for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]},", and the challenge fields for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Challenge"]}," access method — are called out below."]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceType"]}]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]}," (default), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LetterLite"]},". If omitted, defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]},". See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#service-types"},"children":["Service types"]}," below."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceProfile"]}]}," — identifier of the postal-service profile to use. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]}]}," (the profile selects the printing/logistics variant and must be provisioned for your account beforehand). Not used for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LetterLite"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]}]}," — the legal framework applied. Supported values include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Standard"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Advanced"]},", and regional variants such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Standard_EU"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Advanced_EU"]},". Availability depends on the account. EviPost does not support QERDS certification levels."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitProfile"]}]}," — controls which affidavits are generated. If omitted, it is inferred from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]},"; if you set it explicitly, it must be consistent with the certification level. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#affidavit-profiles"},"children":["Affidavit profiles"]}," below."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitsOnDemandEnabled"]}]}," — set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," at submit time to allow on-demand affidavit generation later via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/EviPost/AffidavitRequest"]},". Requires an advanced ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitProfile"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdvancedContentOnSubmit"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdvancedContentOnClose"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdvancedContentOnSubmitAndOnClose"]},"). ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Cannot be enabled retroactively."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnlineRetentionPeriod"]}]}," — years the communication and its evidence remain accessible online. Default: 1 year."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotaryRetentionPeriod"]}]}," — years of notarial custody. Set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5"]}," to apply notarial retention; set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]}," to disable. Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotaryProfile"]}," when greater than 0."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotaryProfile"]}]}," — identifier of the notary for custody. Required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotaryRetentionPeriod > 0"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlMethod"]}]}," — controls how the evidence record is accessed: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Public"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Challenge"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AutoChallenge"]}," (the account's configured default method applies when omitted). When set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Challenge"]},", you must also supply ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlChallenge"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlChallengeResponse"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlChallenge"]}]}," / ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlChallengeResponse"]}]}," — the challenge question and its expected answer. Both are required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlMethod"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Challenge"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Language"]}]}," — language for the evidence record and affidavit documents. If omitted, defaults to your site's configured language."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]}]}," — HTTPS endpoint to receive state callbacks. Optional; if you set it, also set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}," — without a filter, no events are sent."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}]}," — state transitions that trigger a callback. Valid values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Processed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cancelled"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Issued"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Disposed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}," is a platform meta-event that fires when affidavit generation completes — it is not a lifecycle state."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationExtraData"]}]}," — arbitrary string echoed back in every callback."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CostCentre"]}]}," — optional billing group identifier."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFields"]}]}," — array of custom key-value fields attached to the submission. Fields with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IsLookupKey: true"]}," are indexed and returned in query results under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"idempotency","__idx":10},"children":["Idempotency"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyToken"]}," on every Submit. Use a UUID and keep it constant across retries. A replay of a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}," submission returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]},"; the communication is not resubmitted."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"service-types","__idx":11},"children":["Service types"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviPost physical delivery is currently available for destinations within ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Spain"]},". Senders located outside Spain can use EviPost to deliver to Spanish addresses. Availability of each service type and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceProfile"]}," depends on your account provisioning."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"registered-default","__idx":12},"children":["Registered (default)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sends a certified postal communication equivalent to a burofax, delivered through the national postal operator (Correos). The operator tracks the item through the postal chain and reports delivery outcomes. Suitable when you need maximum tracking and evidence coverage. This is the standard choice for most integrations."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Delivery attempts for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]}," are handled by the postal operator and are not configured through the submit request — the delivery-attempt and disposal options below apply to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]}," only."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"letter","__idx":13},"children":["Letter"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sends the document to a printing and enveloping provider (MRW) for certified delivery. Requires prior provisioning by your Namirial Notify contact, and a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceProfile"]}," must be supplied. Supports optional delivery receipt and delivery attempt tracking:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnableDeliveryReceipt"]}]}," — request a signed delivery receipt from the provider."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnableDeliveryAttempts"]}]}," — enable delivery attempt tracking."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryAttemptsNumber"]}]}," — number of delivery attempts before the process ends."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DisposalDaysAmmount"]}]}," — days after which the item is disposed of if undelivered. Note: the field name contains a typo (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ammount"]},") that matches the API contract."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceProfile"]}]}," — profile identifier for the printing and enveloping provider. Required for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]},", and must be provisioned before use."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"letter-lite","__idx":14},"children":["Letter Lite"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A lower-cost printed certified letter (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LetterLite"]},"), delivered through MRW. It is a single-attempt service with the following constraints, enforced at submit time:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Available ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["only for destinations within mainland Spain"]}," — the Spanish islands, Ceuta, Melilla, Portugal, Andorra, and Gibraltar are excluded."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A single delivery attempt — the delivery-attempt options (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnableDeliveryAttempts"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryAttemptsNumber"]},") cannot be used."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["No disposal step — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DisposalDaysAmmount"]}," cannot be used."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceProfile"]}," is not required."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"affidavit-profiles","__idx":15},"children":["Affidavit profiles"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitProfile"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}," controls which affidavits are generated:"]},{"$$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":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No affidavits generated."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Basic"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A single receipt affidavit when tracking is complete. Default for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Standard"]}," certification."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdvancedContentOnSubmit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One affidavit per event, plus a timestamped content affidavit at submission. Default for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Advanced"]}," certification."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdvancedContentOnClose"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One affidavit per event, plus a receipt showing the document body when tracking is complete."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdvancedContentOnSubmitAndOnClose"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Combination of the above two."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To enable on-demand affidavit generation via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/EviPost/AffidavitRequest"]},", set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitsOnDemandEnabled: true"]}," and use an Advanced profile. This cannot be enabled retroactively."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"callbacks-and-what-you-receive","__idx":16},"children":["Callbacks and what you receive"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a state in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}," is reached, Namirial Notify sends an HTTP POST to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"base-payload","__idx":17},"children":["Base 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":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Identifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique ID of this callback delivery. Use it to deduplicate — the platform retries on non-2xx and on timeouts."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Kind"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The state or event that triggered this callback (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Date"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["datetime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Timestamp of the event."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UUID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UniqueId"]}," of the EviPost, as returned at submission."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eviPost"]}," for EviPost callbacks."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Site"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the issuer's site."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Owner"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the account owner."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OwnerEmail"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email address of the account owner."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Event-specific fields. Always includes the fields listed below."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"additionaldata-fields--always-present","__idx":18},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData"]}," fields — always present"]},{"$$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":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sender"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the sender (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Recipient"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the recipient (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientName"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The integrator-assigned lookup key set at submission."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["State"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Current lifecycle state."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CreationDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Timestamp when the communication was submitted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ExtraData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationExtraData"]}," value set at submission, if provided."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"additionaldata-fields--per-event","__idx":19},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData"]}," fields — per event"]},{"$$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":"Callback Kind"},"children":["Callback ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Kind"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Extra fields"},"children":["Extra fields"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Issued"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransmissionDetails"]}," — postal operator transmission details for this event."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Details"]}," — delivery details reported by the postal operator."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Outcome"]}," — the final outcome of the postal process."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitName"]}," — identifiers of the generated affidavit. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequestId"]}," — present when the affidavit was generated on demand."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"callback-reliability","__idx":20},"children":["Callback reliability"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make your handler idempotent, keyed on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Identifier"]},". Return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2xx"]}," promptly. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationExtraData"]}," to embed a routing key for correlation."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"states-reference","__idx":21},"children":["States reference"]},{"$$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":"State"},"children":["State"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Unknown"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["State is not known or has not been mapped."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Draft"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Communication prepared but not yet submitted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Submitted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accepted by the platform, pending document validation and processing."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Processed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Document validated and certified; send request dispatched to the postal operator."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Postal operator acknowledged receipt of the item."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Issued"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Courier collected the item for physical delivery. Operator-specific; not all providers report this step."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Item is in transit with the postal operator or courier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delivered to the recipient. For registered post, this requires the recipient's signature."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Undelivered"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delivery was not possible. Item may be held at a post office or returned."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Missing"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Item cannot be located by the postal operator. Operator-specific intermediate state."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Disposed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Item disposed of after the post-office retention period expired following an undelivered outcome."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A processing or delivery failure occurred."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cancelled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Communication was cancelled by the issuer before delivery was completed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lifecycle complete. No further events expected."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["On timeline:"]}," state changes after ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Processed"]}," are driven entirely by postal operator events. Expect hours or days between transitions. Do not poll aggressively — use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}," to subscribe to the transitions you care about and use Query only as a fallback."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["On ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Issued"]},":"]}," not all postal operators or service profiles report this step. Your integration must not depend on receiving an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Issued"]}," callback — plan for the direct ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched → Sent"]}," path."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"outcomes-reference","__idx":22},"children":["Outcomes reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviPost is the only Namirial Notify service with a distinct set of postal outcomes, reflecting the range of physical delivery results reported by operators:"]},{"$$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":"Outcome"},"children":["Outcome"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Unknown"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Outcome not known or not yet mapped."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No outcome determined yet."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Item dispatched to the operator. Intermediate outcome, may be superseded."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Acknowledged"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Postal operator acknowledged receipt. Operator-specific intermediate outcome."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Item sent and in transit."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Successfully delivered to the recipient."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Declined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipient refused acceptance of the postal communication."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Rejected"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipient rejected the postal communication."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Hindered"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delivery was hindered by an external circumstance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Undelivered"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delivery was not possible."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Disposed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Item disposed of after an undelivered or returned outcome."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Expired"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delivery could not be completed within the postal deadline."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cancelled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cancelled by the issuer."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A processing error prevented normal delivery."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"querying-status","__idx":23},"children":["Querying status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the Query endpoint as a fallback when callbacks lag or for batch reconciliation."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v1/EviPost/Query\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," is omitted, the API defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]},". The default drops to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["25"]}," when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAffidavitsOnResult"]}," is true."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Common filters:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithLookupKeys=your-key"]}," — fetch by your correlation key."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithUniqueIds="]}," — fetch a specific communication by its ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnState=Closed"]}," — fetch only closed communications."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[":::warning State and outcome filters require support guidance"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnState"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithOutcome"]}," filters are available but contact support before using them in production — some state transitions generate internal intermediate values that are not exposed in the documented enum."," ",":::"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"first-call-walkthrough","__idx":24},"children":["First-call walkthrough"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This walkthrough takes you from zero to a completed EviPost with a downloaded affidavit. It covers the happy path: a registered postal communication sent to a single recipient."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"what-you-need","__idx":25},"children":["What you need"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["API credentials for your environment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A PDF document to send (base64-encoded)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Recipient and issuer names, legal names, and physical addresses"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A reachable HTTPS endpoint for callbacks, or a tool such as ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://webhook.site"},"children":["webhook.site"]}," for testing"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-1--submit-the-postal-communication","__idx":26},"children":["Step 1 — Submit the postal communication"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST https://api.evicertia.com/v1/EviPost/Submit \\\n -u \"YOUR_USERNAME:YOUR_PASSWORD\" \\\n -H \"Content-Type: application/json\" \\\n -H \"X-Evi-IdempotencyToken: 550e8400-e29b-41d4-a716-446655440000\" \\\n -d '{\n \"LookupKey\": \"EVIPOST-TEST-001\",\n \"Document\": \"\",\n \"RecipientName\": \"Alice Martin\",\n \"RecipientLegalName\": \"Alice Martin García\",\n \"RecipientAddress\": {\n \"StreetAddress\": \"Calle Mayor 10\",\n \"PostalCode\": \"28001\",\n \"Locality\": \"Madrid\",\n \"Country\": \"ES\"\n },\n \"IssuerName\": \"Acme Corp\",\n \"IssuerLegalName\": \"Acme Corporation S.L.\",\n \"IssuerAddress\": {\n \"StreetAddress\": \"Paseo de la Castellana 200\",\n \"PostalCode\": \"28046\",\n \"Locality\": \"Madrid\",\n \"Country\": \"ES\"\n },\n \"Options\": {\n \"PostServiceType\": \"Registered\",\n \"CertificationLevel\": \"Advanced_EU\",\n \"AffidavitProfile\": \"AdvancedContentOnSubmit\",\n \"PushNotificationUrl\": \"https://your-endpoint.example.com/callbacks/evipost\",\n \"PushNotificationFilter\": [\"Sent\", \"Delivered\", \"Closed\", \"AffidavitPublished\"]\n }\n }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful response returns the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uniqueId"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"uniqueId\": \"69819c3e-0c0e-42b3-a792-a33b014a13a2\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save this ID. It is your primary handle for all queries and callbacks."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-2--verify-the-state-progresses","__idx":27},"children":["Step 2 — Verify the state progresses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Poll the Query endpoint to confirm the EviPost moves through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Submitted → Processed → Dispatched → Issued → Sent"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl \"https://api.evicertia.com/v1/EviPost/Query?WithUniqueIds=69819c3e-0c0e-42b3-a792-a33b014a13a2\" \\\n -u \"YOUR_USERNAME:YOUR_PASSWORD\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Expected response once submitted:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"totalMatches\": 1,\n \"results\": [\n {\n \"evidenceId\": \"69819c3e-0c0e-42b3-a792-a33b014a13a2\",\n \"lookupKey\": \"EVIPOST-TEST-001\",\n \"state\": \"Sent\",\n \"outcome\": \"None\"\n }\n ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviPost tracks a physical postal delivery. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}," means the item was handed to the postal operator. Further state changes (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Undelivered"]},", etc.) depend on the operator and can take days."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-3--receive-callbacks","__idx":28},"children":["Step 3 — Receive callbacks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Depending on the postal operator, you will receive callbacks for one or more source-supported filters such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Disposed"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Undelivered"]}," is reflected in the Query response and final outcome data, not as a standalone push-filter value. When the postal process reaches its end, a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}," callback fires with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Outcome"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not assume ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}," arrives immediately — postal lifecycles typically take days or weeks. Design your callback handler to handle each event independently."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-4--download-the-affidavit","__idx":29},"children":["Step 4 — Download the affidavit"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When you receive an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}," callback, use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitId"]}," from its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData"]}," to download the PDF through the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/downloads-api"},"children":["shared download APIs"]},". You can also list the generated affidavits and their IDs at any time via Query:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl \"https://api.evicertia.com/v1/EviPost/Query?WithUniqueIds=69819c3e-0c0e-42b3-a792-a33b014a13a2&IncludeAffidavitsOnResult=true\" \\\n -u \"YOUR_USERNAME:YOUR_PASSWORD\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response includes an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["affidavits"]}," array with the metadata (ID, name, and kind) of each generated affidavit."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-5--test-the-failure-path","__idx":30},"children":["Step 5 — Test the failure path"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Re-run the walkthrough with a PDF that exceeds the allowed page count, or use an invalid address. Confirm that:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the Submit returns a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}," with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," body describing the error"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UniqueId"]}," is created for the failed request"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["retrying with the same idempotency token and a corrected payload resubmits successfully"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration-checklist","__idx":31},"children":["Integration checklist"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]}," on every Submit and persist ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uniqueId"]}," from the response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyToken"]}," (UUID) on every Submit. Treat ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}," as success."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitsOnDemandEnabled: true"]}," at submit time if you may need to call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitRequest"]}," later — this cannot be enabled retroactively."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Subscribe to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}," if you download affidavits programmatically."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Design for an asynchronous, days-long lifecycle — do not expect state changes within minutes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Do not depend on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Issued"]}," callbacks — plan for the direct ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched → Sent"]}," path since not all operators report this step."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Make your callback handler idempotent, keyed on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Identifier"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use Query as a fallback when callbacks lag — postal events can arrive in bursts or with delays."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When using notary retention (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotaryRetentionPeriod > 0"]},"), always provide a valid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotaryProfile"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"troubleshooting","__idx":32},"children":["Troubleshooting"]},{"$$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":"Symptom"},"children":["Symptom"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Likely causes"},"children":["Likely causes"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What to check"},"children":["What to check"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What to do"},"children":["What to do"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Communication closed immediately as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid PDF document; page count exceeds subscribed tier"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus.errors[]"]},"; Query shows the failure state when an evidence was created"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fix the document and resubmit with a new idempotency token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No state changes after ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Processed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Postal operator has not yet acknowledged; normal for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]}," type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ProcessedOn"]}," timestamp in Query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wait — postal operator events can take hours"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Issued"]}," callback"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operator or service profile does not report this step"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceType"]}," in your submit request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Expected for some operators — continue monitoring for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Communication stays in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}," for days"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Normal for international or standard postal delivery"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SentOn"]}," timestamp; postal operator delivery timelines"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wait — do not resubmit. EviPost has no submit-configurable time-to-live; the lifecycle follows postal-operator timelines"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Undelivered"]}," outcome received"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipient not at address; address incorrect; delivery limit reached"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Details"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}," callback, and the Query response"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact recipient; consider resubmitting to a corrected address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Affidavit not available"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generation is asynchronous; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}," has not fired yet; profile does not generate affidavits for this event"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAffidavitsOnResult=true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wait for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}," callback"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["On-demand affidavit request rejected"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitsOnDemandEnabled"]}," was not set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," at submission; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitProfile"]}," is not Advanced"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Original submit request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cannot be enabled retroactively — resubmit with correct settings"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing required field; invalid certification level; document too large or invalid format"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus.errors[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fix flagged field; retry with new idempotency token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong environment URL; credentials rotated"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Re-issue credentials"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account not provisioned for EviPost"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account permissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact your Namirial Notify account manager"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":33},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evipost-api"},"children":["EviPost API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/issuer/create-evipost"},"children":["How to create a new EviPost"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evimail"},"children":["EviMail"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evinotice"},"children":["EviNotice"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evisms"},"children":["EviSMS"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/api-documentation"},"children":["API documentation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/callbacks"},"children":["Callbacks and webhooks"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/security-best-practices"},"children":["Security and authentication"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/user-guides/states-outcomes"},"children":["States and outcomes"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/user-guides/evidences-affidavits"},"children":["Evidence and affidavits"]}]}]}]},"headings":[{"value":"EviPost","id":"evipost","depth":1},{"value":"When to use EviPost","id":"when-to-use-evipost","depth":2},{"value":"How EviPost works","id":"how-evipost-works","depth":2},{"value":"Lifecycle overview","id":"lifecycle-overview","depth":3},{"value":"Key state transitions","id":"key-state-transitions","depth":3},{"value":"Submit a certified postal communication","id":"submit-a-certified-postal-communication","depth":2},{"value":"Required fields","id":"required-fields","depth":3},{"value":"Optional fields","id":"optional-fields","depth":3},{"value":"Address fields","id":"address-fields","depth":3},{"value":"Options","id":"options","depth":3},{"value":"Idempotency","id":"idempotency","depth":3},{"value":"Service types","id":"service-types","depth":2},{"value":"Registered (default)","id":"registered-default","depth":3},{"value":"Letter","id":"letter","depth":3},{"value":"Letter Lite","id":"letter-lite","depth":3},{"value":"Affidavit profiles","id":"affidavit-profiles","depth":2},{"value":"Callbacks and what you receive","id":"callbacks-and-what-you-receive","depth":2},{"value":"Base payload","id":"base-payload","depth":3},{"value":"AdditionalData fields — always present","id":"additionaldata-fields--always-present","depth":3},{"value":"AdditionalData fields — per event","id":"additionaldata-fields--per-event","depth":3},{"value":"Callback reliability","id":"callback-reliability","depth":3},{"value":"States reference","id":"states-reference","depth":2},{"value":"Outcomes reference","id":"outcomes-reference","depth":2},{"value":"Querying status","id":"querying-status","depth":2},{"value":"First-call walkthrough","id":"first-call-walkthrough","depth":2},{"value":"What you need","id":"what-you-need","depth":3},{"value":"Step 1 — Submit the postal communication","id":"step-1--submit-the-postal-communication","depth":3},{"value":"Step 2 — Verify the state progresses","id":"step-2--verify-the-state-progresses","depth":3},{"value":"Step 3 — Receive callbacks","id":"step-3--receive-callbacks","depth":3},{"value":"Step 4 — Download the affidavit","id":"step-4--download-the-affidavit","depth":3},{"value":"Step 5 — Test the failure path","id":"step-5--test-the-failure-path","depth":3},{"value":"Integration checklist","id":"integration-checklist","depth":2},{"value":"Troubleshooting","id":"troubleshooting","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"title":"EviPost","description":"End-to-end integration guide for EviPost — certified physical postal communications through Namirial Notify.","layout":"doc","outline":"deep","keywords":["evipost","certified postal delivery","certified physical letter","burofax","postal evidence","delivery receipt","affidavit","registered letter","namirial notify"],"seo":{"title":"EviPost"}},"lastModified":"2026-07-28T10:32:13.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/namirialnotify/services/evipost","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}