{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/namirialnotify/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"EviPost API","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-api","__idx":0},"children":["EviPost API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The EviPost API lets you submit certified physical postal communications (equivalent to a burofax) and query the status of previously submitted items. It is a REST API that uses HTTP Basic authentication and returns JSON responses."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For end-to-end lifecycle, postal service types, and integration guidance, see the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evipost"},"children":["EviPost service guide"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"environments","__idx":1},"children":["Environments"]},{"$$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":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Base URL"},"children":["Base URL"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Production"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.evicertia.com"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pre-production / QA"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.ecertia.com"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the public Namirial Notify API environments, this V1 service is exposed under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1"]}," base path. Use public routes such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/EviPost/Submit"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/EviPost/Query"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/EviPost/AffidavitRequest"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Some lower-level technical artifacts may show these V1 routes without the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1"]}," prefix. For customer integrations, use the public ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1"]}," base path shown in this documentation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For shared environment guidance across services, see the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/overview#environments"},"children":["API reference overview"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":2},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All endpoints require ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Basic authentication"]},". Pass your Namirial Notify credentials as the username and password in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Authorization: Basic <base64(username:password)>\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/security-best-practices#credential-handling"},"children":["credential handling"]},", ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/security-best-practices#callback-endpoint-hardening"},"children":["callback endpoint hardening"]},", and ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/security-best-practices#operational-security-checks-before-go-live"},"children":["operational security checks"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"idempotency","__idx":3},"children":["Idempotency"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviPost Submit supports idempotent submission. Include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyToken"]}," header with a unique value per logical operation (a GUID is recommended)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the same token is submitted again after the original request completed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]},", the server returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}," with the original response body — the communication is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," resubmitted."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following response codes are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," cached and will re-execute the request regardless of token: ",{"$$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":["409"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5xx"]}," responses."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-responses","__idx":4},"children":["Error responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviPost v1 uses a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," object for error responses."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"responseStatus\": {\n    \"errorCode\": \"ArgumentException\",\n    \"message\": \"RecipientAddress.Country is required.\",\n    \"errors\": [\n      {\n        \"errorCode\": \"NotEmpty\",\n        \"fieldName\": \"RecipientAddress.Country\",\n        \"message\": \"RecipientAddress.Country is required.\"\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$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":["errorCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Machine-readable error classifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human-readable summary of the error"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of field-level validation errors (present on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," responses)"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Common status codes and their causes:"]},{"$$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":"Typical cause"},"children":["Typical cause"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$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":["Missing required field, invalid address, invalid certification level, document too large, or business rule failure"]}]},{"$$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":["Incorrect credentials or missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header"]}]},{"$$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":["Account not provisioned for EviPost"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For shared error handling guidance, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/error-handling"},"children":["Error handling"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"endpoints","__idx":5},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"submit-a-certified-postal-communication","__idx":6},"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":["Submits a new certified postal communication. On success, returns a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UniqueId"]}," that identifies the submission and can be used to query its status later."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required fields:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Document"]}," (base64-encoded PDF), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientAddress"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Optional fields include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientLegalName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerLegalName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerAddress"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientPhone"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientEmail"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerPhone"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerEmail"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerComments"]},"."]},{"$$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":"Response"},"children":["Response"]},{"$$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":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Postal communication accepted. Body contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"uniqueId\": \"...\" }"]}," — the UUID of the submitted postal communication. (EviMail and EviSMS return the equivalent identifier as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eviId"]},".)"]}]},{"$$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":["Returned when an idempotent replay matches a previously ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}," submission. The original response body is returned unchanged."]}]},{"$$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":["Invalid request or business rule failure. The response body contains a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," object with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]},", and an optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," array of field-level details."]}]},{"$$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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The account is not provisioned for EviPost. Contact your Namirial Notify account manager to enable this service."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#idempotency"},"children":["Idempotency"]}," above for retry safety guidance."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example request:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/EviPost/Submit HTTP/1.1\nAuthorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==\nContent-Type: application/json\n\n{\n  \"LookupKey\": \"a2R4S25kWiu79fsbubSXkw==\",\n  \"Document\": \"<base64-encoded PDF>\",\n  \"RecipientName\": \"Juan Valido\",\n  \"RecipientLegalName\": \"Juan Valido\",\n  \"RecipientAddress\": {\n    \"StreetAddress\": \"Gran Via 74, 5 A\",\n    \"PostalCode\": \"28014\",\n    \"Locality\": \"Madrid\",\n    \"Region\": \"Madrid\",\n    \"Country\": \"ES\"\n  },\n  \"IssuerName\": \"Pedro Comprador\",\n  \"IssuerLegalName\": \"Pedro Valido\",\n  \"IssuerAddress\": {\n    \"StreetAddress\": \"C/ Gran Via, 1, 1-A\",\n    \"PostalCode\": \"28001\",\n    \"Locality\": \"Madrid\",\n    \"Region\": \"Madrid\",\n    \"Country\": \"ES\"\n  },\n  \"IssuerPhone\": \"+34677888777\",\n  \"IssuerEmail\": \"pedro.comprador@example.com\",\n  \"IssuerComments\": \"Sending in March.\",\n  \"Options\": {\n    \"PostServiceType\": \"Registered\",\n    \"CertificationLevel\": \"Advanced_EU\",\n    \"NotaryRetentionPeriod\": 5,\n    \"OnlineRetentionPeriod\": 1\n  }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example response:"]}]},{"$$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":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-certified-postal-communications","__idx":7},"children":["Query certified postal communications"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v1/EviPost/Query\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a list of postal communications matching the specified filters. Results are paginated using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Offset"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query parameters:"]}]},{"$$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":"Parameter"},"children":["Parameter"]},{"$$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":["WithUniqueIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by one or more unique IDs (comma-separated)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithLookupKeys"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by one or more lookup keys (comma-separated)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnState"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by current state. Contact support before using this parameter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithOutcome"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by outcome. Contact support before using this parameter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OrderResultsBy"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sort field for results. Supported value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CreationDate"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Offset"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of results to skip."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum number of results to return."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeDocumentOnResult"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Include the original document (base64 PDF) in results."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAffidavitsOnResult"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Include affidavit metadata in results."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAffidavitBlobsOnResult"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Deprecated. When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAffidavitsOnResult=true"]},", include each affidavit PDF as Base64 in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["affidavits[].bytes"]},"; blob queries are limited to one postal communication. Set this to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}," for metadata-only results and use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/AffidavitsDownload"]}," for new integrations."]}]}]}]}]},{"$$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":"Response"},"children":["Response"]},{"$$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":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"totalMatches\": N, \"results\": [...] }"]},"."]}]},{"$$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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The account is not provisioned for EviPost. Contact your Namirial Notify account manager to enable this service."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," is omitted, the API uses a default of ",{"$$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":["With the deprecated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAffidavitBlobsOnResult=false"]},","," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAffidavitsOnResult=true"]}," adds affidavit metadata and IDs without"," ","embedding the PDF files. Pass the returned affidavit IDs to the shared"," ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/downloads-api#download-affidavit-pdfs-by-id"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/AffidavitsDownload"]}]}," endpoint"," ","to retrieve the signed PDFs in a ZIP archive. This is the recommended retrieval"," ","flow for new integrations."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example request:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v1/EviPost/Query?WithUniqueIds=3977d143-a6cb-4642-abc6-a33b016cbec2&IncludeAffidavitsOnResult=true&IncludeAffidavitBlobsOnResult=false HTTP/1.1\nAuthorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example response:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"results\": [\n    {\n      \"evidenceId\": \"3977d143-a6cb-4642-abc6-a33b016cbec2\",\n      \"lookupKey\": \"a2R4S25kWiu79fsbubSXkw==\",\n      \"recipientName\": \"Juan Valido\",\n      \"address\": {\n        \"streetAddress\": \"Gran Via 74, 5 A\",\n        \"postalCode\": \"28014\",\n        \"locality\": \"Madrid\",\n        \"region\": \"Madrid\",\n        \"country\": \"ES\"\n      },\n      \"state\": \"Sent\",\n      \"stateDate\": \"2026-01-15T10:00:07Z\",\n      \"lastStateChangeDate\": \"2026-01-15T10:00:11Z\",\n      \"outcome\": \"None\",\n      \"outcomeDate\": \"2026-01-15T10:00:00Z\",\n      \"creationDate\": \"2026-01-15T10:00:00Z\",\n      \"submittedOn\": \"2026-01-15T10:00:00Z\",\n      \"processedOn\": \"2026-01-15T10:00:03Z\",\n      \"sentOn\": \"2026-01-15T10:00:07Z\",\n      \"timeToLive\": 43200,\n      \"costCentre\": \"dept-legal\",\n      \"affidavits\": [\n        {\n          \"uniqueId\": \"000c1f70-42ac-a3ea-149f-943879726a87\",\n          \"date\": \"2026-01-15T10:00:12Z\",\n          \"evidenceUniqueId\": \"3977d143-a6cb-4642-abc6-a33b016cbec2\",\n          \"description\": \"Certification of postal communication\"\n        }\n      ]\n    }\n  ],\n  \"totalMatches\": 1\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-an-on-demand-affidavit","__idx":8},"children":["Request an on-demand affidavit"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /v1/EviPost/AffidavitRequest\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Generates a custom affidavit for a previously submitted EviPost. To use this endpoint, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitsOnDemandEnabled: true"]}," must have been set in the original Submit request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body:"]}]},{"$$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":["UniqueId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string (UUID)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required. Unique ID of the EviPost to generate an affidavit for."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeDocument"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Include the original document in the affidavit."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeEvents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Include detailed event information in the affidavit."]}]}]}]}]},{"$$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":"Response"},"children":["Response"]},{"$$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":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"requestId\": \"...\" }"]},"."]}]},{"$$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":["Business rule or validation failure. The response body contains a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," object with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]},", and an optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," array."]}]},{"$$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":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example request:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/EviPost/AffidavitRequest HTTP/1.1\nAuthorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==\nContent-Type: application/json\n\n{\n  \"UniqueId\": \"87ffa214-e773-4bd5-9b8d-a8ef00fd80f8\",\n  \"IncludeDocument\": true,\n  \"IncludeEvents\": true\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example response:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"requestId\": \"79726a87000c1f7042aca3ea149f9438\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"cancel-a-postal-communication","__idx":9},"children":["Cancel a postal communication"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /v1/EviPost/Cancel\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cancels a previously submitted EviPost that has not yet been dispatched to the postal carrier. Only the account that originally submitted the postal communication can cancel it."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Permission required"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint requires the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CanUseCancel"]}," permission in addition to the standard EviPost API permission. Contact your Namirial Notify account manager if you need this permission enabled."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body:"]}]},{"$$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":["UniqueId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string (UUID)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required. Unique ID of the EviPost to cancel, as returned at submission."]}]}]}]}]},{"$$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":"Response"},"children":["Response"]},{"$$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":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"uniqueId\": \"...\" }"]}," — the ID of the cancelled postal communication."]}]},{"$$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":["Invalid request. The UniqueId is missing or not a valid UUID."]}]},{"$$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, or the authenticated account is not the owner of the postal communication."]}]},{"$$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 account lacks the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CanUseCancel"]}," permission, or EviPost is not enabled for this account."]}]},{"$$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":["No postal communication with the given UniqueId was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example request:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/EviPost/Cancel HTTP/1.1\nAuthorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==\nContent-Type: application/json\n\n{\n  \"UniqueId\": \"69819c3e-0c0e-42b3-a792-a33b014a13a2\"\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example response:"]}]},{"$$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":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"states-and-outcomes","__idx":10},"children":["States and outcomes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a cross-service explanation of lifecycle terminology, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/user-guides/states-outcomes"},"children":["States and outcomes"]},". For a visual lifecycle reference, see the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/user-guides/states-outcomes#evipost-evidence-lifecycle"},"children":["EviPost evidence lifecycle"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["States"]}," represent the current step in the postal communication lifecycle."]},{"$$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":["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 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":["Locally processed and queued for 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":["Dispatched to the postal communication system."]}]},{"$$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":["Item issued 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":["Sent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Handed off to the postal operator or messaging service."]}]},{"$$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":["Undelivered"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The operator reported non-delivery. This does not itself close tracking or identify a collection or return-to-sender action."]}]},{"$$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":["Value exposed by the API contract; no normal transition into this state is defined by the current lifecycle implementation. Contact support if it appears."]}]},{"$$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 final recipient."]}]},{"$$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":["The provider reported destruction of the undelivered item under a service configured for disposal."]}]},{"$$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."]}]},{"$$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":["Postal tracking is complete and the outcome is final. Affidavit publication can still follow."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Outcomes"]}," represent the result recorded so far and can change while the communication remains open. Use the outcome at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}," as the final result."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An individual delivery-attempt event does not itself change the state to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Undelivered"]},". For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]}," with delivery tracking enabled, the platform accepts a later valid delivery report before closure; whether an operator emits that sequence is unconfirmed. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LetterLite"]}," cannot complete normal closure with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}," once non-delivery has been recorded. A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]}," workflow configured for disposal can continue to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Disposed"]},"; a later failure report for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]}," can instead lead to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]}," before closure. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LetterLite"]}," can close with a final ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Undelivered"]}," outcome. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evipost#delivery-attempts-and-non-delivery"},"children":["Delivery attempts and non-delivery"]}," for operator details and callback guidance."]},{"$$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":["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 postal operator (intermediate outcome, may be superseded)."]}]},{"$$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. This can be the final outcome for plain ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]}," without delivery receipt, attempt tracking, or disposal."]}]},{"$$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":["Defined in the API contract and domain, but not emitted by the current postal event handlers. Recipient refusal is reported as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Rejected"]},"."]}]},{"$$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":["Acknowledged"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value exposed by the API contract but not produced by the current lifecycle implementation. Contact support if it appears."]}]},{"$$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":["Value exposed by the API contract but not produced by the current lifecycle implementation. Contact support if it appears."]}]},{"$$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":["Non-delivery was reported. Final only when the communication is ",{"$$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":["Failed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A processing error prevented normal delivery."]}]},{"$$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":["Disposed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Destruction of the undelivered item was reported for a service configured for disposal."]}]},{"$$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":["Expired"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delivery could not be completed within the postal deadline."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-request-fields","__idx":11},"children":["Key request fields"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"document","__idx":12},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Document"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The document or letter to be sent, provided as a base64-encoded PDF string."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"recipientaddress--issueraddress","__idx":13},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientAddress"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerAddress"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both address objects share the same shape:"]},{"$$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":["Region"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conditional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Province or region. Required in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RecipientAddress"]}," for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]},". The issuer region must also be present, either supplied in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerAddress"]}," or filled from the site address."]}]},{"$$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":["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":14},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}," object groups all processing and certification settings."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}," fields are optional at the API level: omit one and the platform applies a default (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceType"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Language"]}," → your site's configured language, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitProfile"]}," → inferred from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlMethod"]}," → the account's configured default method). The Web form preselects its own account or site defaults; these need not match the API defaults. The Web service type comes from the site configuration. The only conditional requirements are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceProfile"]}," (when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]},") and the challenge fields (when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlMethod"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Challenge"]},")."]}]},{"$$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":["PostServiceType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]}," (default), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LetterLite"]},". Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]}," if omitted. See details below."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Profile identifier for the postal service. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]}]}," (provisioned by support). Not used for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LetterLite"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Legal framework for certification. 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 levels."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Controls which affidavits are generated. If omitted, it is inferred from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]},"; if set, it must be consistent with the certification level. See details below."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitsOnDemandEnabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean. Enables on-demand affidavit generation via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitRequest"]},". Requires an advanced content profile (",{"$$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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnlineRetentionPeriod"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Time in years for online evidence retention. Default: 1 year."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotaryRetentionPeriod"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If set, applies 5-year notarial custody. Set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]}," to disable."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotaryProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotaryRetentionPeriod > 0"]},". Identifier of the notary for custody."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlMethod"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Controls how recipients access the evidence: ",{"$$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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Challenge"]},", also supply ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlChallenge"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlChallengeResponse"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlChallenge"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlChallengeResponse"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Challenge question and expected answer. Both required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlMethod"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Challenge"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CostCentre"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Groups submissions for billing/reporting purposes."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Array of custom key-value fields (see ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFields"]}," below)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. URL to receive state-change callbacks."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Array of states that trigger a callback."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Language"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Language for the evidence record and generated affidavits (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["es"]},"). Defaults to your site's configured language if omitted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnableDeliveryReceipt"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]}," type: request a delivery receipt from the provider."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EnableDeliveryAttempts"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]}," type: enable delivery attempt tracking."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryAttemptsNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]}," type: number of delivery attempts to request from the provider."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DisposalDaysAmmount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]}," type: number of days after which the item is disposed of if undelivered."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationExtraData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Free-text passed through in every callback payload."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"postservicetype","__idx":15},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceType"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Controls the type of postal delivery. EviPost physical delivery is currently available for destinations within ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Spain"]},"; availability of each type depends on your account provisioning."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Registered"]}," — Default. Sends a certified postal communication equivalent to a burofax, delivered through the national postal operator (Correos). Delivery attempts are handled by the operator and are not configured in the submit request."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Letter"]}," — Sends to a printing and enveloping provider (MRW). Requires prior provisioning by support and a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceProfile"]},". Supports optional delivery receipt and delivery attempt tracking."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LetterLite"]}," — A lower-cost single-attempt printed certified letter (MRW). Available ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["only within mainland Spain"]}," (the islands, Ceuta, Melilla, Portugal, Andorra, and Gibraltar are excluded). The delivery-attempt and disposal options cannot be used, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PostServiceProfile"]}," is not required."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"certificationlevel","__idx":16},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Defines the legal framework and geographic variant for certification. The API accepts ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Standard"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Advanced"]},", and regional values such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Standard_EU"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Advanced_EU"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Standard_CO"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Advanced_MX"]},". Availability depends on the account. EviPost does not support QERDS certification levels."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"affidavitprofile","__idx":17},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitProfile"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Controls what affidavits are generated during the process:"]},{"$$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":"Heading","attributes":{"level":3,"id":"pushnotificationfilter","__idx":18},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An array of event names that trigger a callback to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]},". Valid values for EviPost: ",{"$$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":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}," is not a lifecycle state — it is a platform meta-event that fires when affidavit generation for this communication completes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"pushnotificationextradata","__idx":19},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationExtraData"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A free-text field for additional data to be included in every push notification sent to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]},". Available in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData.ExtraData"]}," field of the callback payload."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"customfields","__idx":20},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomFields"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An array of custom key-value fields attached to the submission. Each field requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Label"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Value"]},". Fields marked with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IsLookupKey: true"]}," are indexed and surfaced in query results under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]},", concatenated with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["::"]}," if multiple values are present."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"push-notification-payload","__idx":21},"children":["Push notification payload"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When an EviPost changes state, Namirial Notify sends a POST to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]}," with the following JSON payload:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Common 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":["Identifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the event."]}]},{"$$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":["Event type (matches the state that triggered the notification)."]}]},{"$$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":["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":["Unique identifier of the EviPost."]}]},{"$$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":["Always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eviPost"]},"."]}]},{"$$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":["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":["Name of the site user."]}]},{"$$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":["Email of the site user."]}]},{"$$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 containing event-specific fields (see below)."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData"]}," 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":["Sender"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the sender."]}]},{"$$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":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["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 state name."]}]},{"$$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":["Submission date."]}]},{"$$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":["Value of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationExtraData"]},", if set."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}," events, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData"]}," also includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransmissionDetails"]},". For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]},", it includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Details"]},". For ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]},", it includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Outcome"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example payload (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Processed"]}," event):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"Identifier\": \"600a41fd-d96b-4c4b-abb2-a87000d7da3f\",\n  \"EvidenceId\": \"bae409d127de4b18b97ca87000c75b1c\",\n  \"EvidenceType\": \"eviPost\",\n  \"Kind\": \"Processed\",\n  \"Date\": \"2018-01-22T12:05:53.5875507Z\",\n  \"Site\": \"pruebas\",\n  \"Owner\": \"Pruebas evicertia\",\n  \"OwnerEmail\": \"pruebas@evicertia.com\",\n  \"AdditionalData\": {\n    \"Sender\": \"Pedro Comprador\",\n    \"Recipient\": \"Juan Valido\",\n    \"LookupKey\": \"push-notification-test\",\n    \"State\": \"Processed\",\n    \"CreationDate\": \"2018-01-22T13:05:49.9850990+01:00\",\n    \"ExtraData\": \"{\\\"myId\\\": \\\"99cf386b-1590-4ddb-af68-607b3e7c1194\\\"}\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"on-demand-affidavit-callback","__idx":22},"children":["On-demand affidavit callback"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When an affidavit requested via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitRequest"]}," has been generated, Namirial Notify may send the normal ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}," push notification to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]}," configured on the original submission, when the original ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}," includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]},". For on-demand affidavits, the payload can include the request identifier in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData.RequestId"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example payload:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"Identifier\": \"1234\",\n  \"EvidenceId\": \"2aca3ea149f943879726a87000c1f704\",\n  \"EvidenceType\": \"eviPost\",\n  \"Kind\": \"AffidavitPublished\",\n  \"Date\": \"2018-01-22T12:46:32.4830752+01:00\",\n  \"Site\": \"pruebas\",\n  \"Owner\": \"Pruebas evicertia\",\n  \"OwnerEmail\": \"pruebas@evicertia.com\",\n  \"AdditionalData\": {\n    \"RequestId\": \"79726a87000c1f7042aca3ea149f9438\",\n    \"AffidavitId\": \"000c1f7042aca3ea149f943879726a87\",\n    \"AffidavitName\": \"Certification of postal communication (upon request)\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"openapi-specification","__idx":23},"children":["OpenAPI specification"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The OpenAPI 3.0.3 specification for the EviPost API provides a machine-readable definition of the service endpoints, request and response schemas, authentication method, and error responses."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Covered in the specification:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Submit endpoint"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/EviPost/Submit"]},") — detailed request and response schemas, idempotency headers, validation rules, and HTTP status codes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query endpoint"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/EviPost/Query"]},") — pagination parameters, filtering by ID or lookup key, state and outcome enums, and result structure"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Affidavit request endpoint"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/EviPost/AffidavitRequest"]},") — on-demand affidavit generation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authentication"]}," — HTTP Basic authentication requirements"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error handling"]}," — V1 service-style error responses with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," object containing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data types"]}," — schema definitions for documented addresses, postal options, certification levels, and evidence metadata"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The OpenAPI spec can be used to generate client libraries, integration tests, or interactive API documentation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/oas/evipost-api"},"children":["View OpenAPI spec →"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":24},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evipost"},"children":["EviPost"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evimail-api"},"children":["EviMail API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evinotice-api"},"children":["EviNotice API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evisms-api"},"children":["EviSMS API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/overview"},"children":["API reference overview"]}]},{"$$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/error-handling"},"children":["Error handling"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/integration-patterns"},"children":["Integration workflows"]}]},{"$$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 API","id":"evipost-api","depth":1},{"value":"Environments","id":"environments","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Idempotency","id":"idempotency","depth":2},{"value":"Error responses","id":"error-responses","depth":2},{"value":"Endpoints","id":"endpoints","depth":2},{"value":"Submit a certified postal communication","id":"submit-a-certified-postal-communication","depth":3},{"value":"Query certified postal communications","id":"query-certified-postal-communications","depth":3},{"value":"Request an on-demand affidavit","id":"request-an-on-demand-affidavit","depth":3},{"value":"Cancel a postal communication","id":"cancel-a-postal-communication","depth":3},{"value":"States and outcomes","id":"states-and-outcomes","depth":2},{"value":"Key request fields","id":"key-request-fields","depth":2},{"value":"Document","id":"document","depth":3},{"value":"RecipientAddress / IssuerAddress","id":"recipientaddress--issueraddress","depth":3},{"value":"Options","id":"options","depth":3},{"value":"PostServiceType","id":"postservicetype","depth":3},{"value":"CertificationLevel","id":"certificationlevel","depth":3},{"value":"AffidavitProfile","id":"affidavitprofile","depth":3},{"value":"PushNotificationFilter","id":"pushnotificationfilter","depth":3},{"value":"PushNotificationExtraData","id":"pushnotificationextradata","depth":3},{"value":"CustomFields","id":"customfields","depth":3},{"value":"Push notification payload","id":"push-notification-payload","depth":2},{"value":"On-demand affidavit callback","id":"on-demand-affidavit-callback","depth":3},{"value":"OpenAPI specification","id":"openapi-specification","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"title":"EviPost API","description":"REST API reference for EviPost — submit and query certified physical postal communications through Namirial Notify.","layout":"doc","outline":"deep","keywords":["evipost api","certified postal api","burofax api","postal submit","postal query","namirial notify api","rest api"],"seo":{"title":"EviPost API"}},"lastModified":"2026-09-28T08:44:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/namirialnotify/apis/evipost-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}