{"items":[{"type":"link","label":"EviPost API","link":"/products/namirialnotify/apis/oas/evipost-api","routeSlug":"/products/namirialnotify/apis/oas/evipost-api","content":{"contentType":"overview","meta":{"name":"EviPost API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"evipost-api.json","url":"/_bundle/products/namirialnotify/apis/oas/evipost-api.json?download"},{"kind":"download","label":"evipost-api.yaml","url":"/_bundle/products/namirialnotify/apis/oas/evipost-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.evicertia.com/v1","description":"Production"},{"url":"https://api.ecertia.com/v1","description":"Pre-production / QA"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"EviPost API (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REST API for submitting and querying certified physical postal communications through Namirial Notify, with configurable certification and custody, asynchronous affidavit generation, and event callbacks. For the public Namirial Notify API environments, this V1 service is exposed under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" base path. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"servers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entries below already include that public base path. Some lower-level technical artifacts may show the underlying route without the prefix. For customer integrations, use the public URLs produced by this specification."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"EviPost","link":"/products/namirialnotify/apis/oas/evipost-api/evipost","routeSlug":"/products/namirialnotify/apis/oas/evipost-api/evipost","items":[{"label":"Submit a certified postal communication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialnotify/apis/oas/evipost-api/evipost/evipostsubmit","routeSlug":"/products/namirialnotify/apis/oas/evipost-api/evipost/evipostsubmit","metadata":{"seo":{"title":"Submit a certified postal communication","description":"Submit a Base64-encoded PDF smaller than 2,097,152 bytes before encoding. Acceptance does not confirm later PDF validation or postal delivery. A processing failure or postal-service rejection can close the communication with outcome Failed; use Query to check the outcome."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviPostSubmit","name":"Submit a certified postal communication","isWebhook":false,"pointer":"/paths/~1EviPost~1Submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a certified postal communication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit a Base64-encoded PDF smaller than 2,097,152 bytes before encoding. Acceptance does not confirm later PDF validation or postal delivery. A processing failure or postal-service rejection can close the communication with outcome "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; use Query to check the outcome."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Evi-IdempotencyToken","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional idempotency token (GUID recommended) to prevent duplicate submissions on retry. A replay of a cached "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200 OK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" submission returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202 Accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Responses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"408"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not cached for replay."},"children":[]}]}]}]}],"pointer":"/paths/~1EviPost~1Submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviPostSubmitRequest","exampleIds":["paths/~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost"]}},"schemaId":"components/schemas/EviPostSubmitRequest","exampleIds":["paths/~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost"],"pointer":"/paths/~1EviPost~1Submit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/EviPost/Submit","servers":[{"url":"https://api.evicertia.com/v1","description":"Production"},{"url":"https://api.ecertia.com/v1","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Evi-IdempotencyToken","in":"header","required":false,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviPostSubmitRequest","exampleIds":["paths/~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost"]}},"responseCodes":["200","202","400","401","403","409","492"],"pointer":"/EviPost/Submit","href":"evipost/evipostsubmit","openApiOperationId":"eviPostSubmit","summary":"Submit a certified postal communication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com/v1","description":"Production"},{"url":"https://api.ecertia.com/v1","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviPostSubmitRequest","exampleIds":["paths/~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviPostSubmitRequest","exampleIds":["paths/~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Postal communication accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostSubmitResponse","exampleIds":["paths/~1EviPost~1Submit/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviPostSubmitResponse","exampleIds":["paths/~1EviPost~1Submit/post/responses/200/content/application~1json/example"],"headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["New"]}}},"headerSchemaId":"schema_1"},{"code":"202","description":"Idempotent replay. The same X-Evi-IdempotencyToken was used for a cached 200 OK submission. The original response body is returned; the postal communication is not resubmitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostSubmitResponse"}},"schemaId":"components/schemas/EviPostSubmitResponse","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["Replay"]}}},"headerSchemaId":"schema_2"},{"code":"400","description":"Invalid request or business rule failure","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostError"}},"schemaId":"components/schemas/EviPostError"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"Access denied. The authenticated account is not provisioned for EviPost. Contact your Namirial Notify account manager to enable this service.\n"},{"code":"409","description":"Another Submit with the same X-Evi-IdempotencyToken is currently in flight.","headers":{"X-Evi-IdempotencyStatus":{"description":"Idempotency outcome for the submission request.","schema":{"type":"string","enum":["Conflict"]}}},"headerSchemaId":"schema_3"},{"code":"492","description":"Submission quota for this recipient or for this service type on the site was reached. Avoid retrying immediately; contact support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostError"}},"schemaId":"components/schemas/EviPostError"}],"pointer":"/paths/~1EviPost~1Submit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviPostSubmitResponse","exampleIds":["paths/~1EviPost~1Submit/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostSubmitResponse","exampleIds":["paths/~1EviPost~1Submit/post/responses/200/content/application~1json/example"]}}},{"code":"202","schemaId":"components/schemas/EviPostSubmitResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostSubmitResponse"}}},{"code":"400","schemaId":"components/schemas/EviPostError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostError"}}},{"code":"401"},{"code":"403"},{"code":"409"},{"code":"492","schemaId":"components/schemas/EviPostError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evipost/evipostsubmit"}],"panels":[]}]},"httpPath":"/EviPost/Submit"},{"label":"Query certified postal communications (GET)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialnotify/apis/oas/evipost-api/evipost/evipostqueryget","routeSlug":"/products/namirialnotify/apis/oas/evipost-api/evipost/evipostqueryget","metadata":{"seo":{"title":"Query certified postal communications (GET)","description":"Query certified postal communications (GET)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviPostQueryGet","name":"Query certified postal communications (GET)","isWebhook":false,"pointer":"/paths/~1EviPost~1Query/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query certified postal communications (GET)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"WithUniqueIds","in":"query","schemaId":"schema_0","description":"Filter by one or more unique IDs (comma-separated)."},{"name":"WithLookupKeys","in":"query","schemaId":"schema_0","description":"Filter by one or more lookup keys (comma-separated)."},{"name":"OnState","in":"query","schemaId":"schema_4","description":"Filter by current state. Contact support before using this parameter."},{"name":"WithOutcome","in":"query","schemaId":"schema_5","description":"Filter by outcome. Contact support before using this parameter."},{"name":"OrderResultsBy","in":"query","schemaId":"schema_6","description":"Sort field for results."},{"name":"Offset","in":"query","schemaId":"schema_7","description":"Number of results to skip for pagination."},{"name":"Limit","in":"query","schemaId":"schema_8","description":"Default and maximum are 100 without affidavits, 25 with affidavit metadata, and 1 with embedded affidavit PDFs.\n"},{"name":"IncludeDocumentOnResult","in":"query","schemaId":"schema_9","description":"Include the base64-encoded original document in results."},{"name":"IncludeAffidavitsOnResult","in":"query","schemaId":"schema_9","description":"Include affidavit metadata in results."},{"name":"IncludeAffidavitBlobsOnResult","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When enabled with IncludeAffidavitsOnResult, embeds Base64 affidavit PDFs in affidavits[].bytes. Some deployments enable blobs when this flag is omitted. Set false explicitly for metadata-only results and use /AffidavitsDownload to fetch PDFs."},"children":[]}]}]}],"deprecated":true}],"pointer":"/paths/~1EviPost~1Query/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/EviPost/Query","servers":[{"url":"https://api.evicertia.com/v1","description":"Production"},{"url":"https://api.ecertia.com/v1","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[{"name":"WithUniqueIds","in":"query","schemaId":"schema_0"},{"name":"WithLookupKeys","in":"query","schemaId":"schema_0"},{"name":"OnState","in":"query","schemaId":"schema_4"},{"name":"WithOutcome","in":"query","schemaId":"schema_5"},{"name":"OrderResultsBy","in":"query","schemaId":"schema_6"},{"name":"Offset","in":"query","schemaId":"schema_7"},{"name":"Limit","in":"query","schemaId":"schema_8"},{"name":"IncludeDocumentOnResult","in":"query","schemaId":"schema_9"},{"name":"IncludeAffidavitsOnResult","in":"query","schemaId":"schema_9"},{"name":"IncludeAffidavitBlobsOnResult","in":"query","schemaId":"schema_9"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/EviPost/Query","href":"evipost/evipostqueryget","openApiOperationId":"eviPostQueryGet","summary":"Query certified postal communications (GET)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com/v1","description":"Production"},{"url":"https://api.ecertia.com/v1","description":"Pre-production / QA"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Query executed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostQueryResponse","exampleIds":["paths/~1EviPost~1Query/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviPostQueryResponse","exampleIds":["paths/~1EviPost~1Query/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid query, including a limit above the applicable maximum.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostError"}},"schemaId":"components/schemas/EviPostError"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"Access denied. The authenticated account is not provisioned for EviPost. Contact your Namirial Notify account manager to enable this service.\n"}],"pointer":"/paths/~1EviPost~1Query/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviPostQueryResponse","exampleIds":["paths/~1EviPost~1Query/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostQueryResponse","exampleIds":["paths/~1EviPost~1Query/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/EviPostError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostError"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evipost/evipostqueryget"}],"panels":[]}]},"httpPath":"/EviPost/Query"},{"label":"Cancel a postal communication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialnotify/apis/oas/evipost-api/evipost/evipostcancel","routeSlug":"/products/namirialnotify/apis/oas/evipost-api/evipost/evipostcancel","metadata":{"seo":{"title":"Cancel a postal communication","description":"Requests cancellation of a previously submitted EviPost. Use this operation for Letter with a delivery receipt, delivery attempts, or disposal enabled. The communication must not be Draft or Closed, and the request must be within the configured cancellation window (30 minutes from creation by default). Only the submitting account can request cancellation. Requires CanUseCancel and the standard EviPost API permission. A successful response accepts the request for asynchronous processing; it does not confirm cancellation by the postal operator. To confirm cancellation, check that Query reports the Cancelled state, or the Closed state with the Cancelled outcome. A Cancelled callback confirms cancellation only when AdditionalData.Success is true; false reports an unsuccessful attempt. The API can accept LetterLite requests, but the current cancellation processor does not support that service type; contact support if cancellation is needed. Requests that fail an eligibility check are rejected. A non-2xx response means the request was not accepted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviPostCancel","name":"Cancel a postal communication","isWebhook":false,"pointer":"/paths/~1EviPost~1Cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a postal communication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests cancellation of a previously submitted EviPost. Use this operation for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a delivery receipt, delivery attempts, or disposal enabled. The communication must not be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the request must be within the configured cancellation window (30 minutes from creation by default). Only the submitting account can request cancellation. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CanUseCancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the standard EviPost API permission. A successful response accepts the request for asynchronous processing; it does not confirm cancellation by the postal operator. To confirm cancellation, check that Query reports the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state, or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" outcome. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" callback confirms cancellation only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdditionalData.Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reports an unsuccessful attempt. The API can accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LetterLite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requests, but the current cancellation processor does not support that service type; contact support if cancellation is needed. Requests that fail an eligibility check are rejected. A non-2xx response means the request was not accepted."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviPostCancelRequest","exampleIds":["paths/~1EviPost~1Cancel/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EviPostCancelRequest","exampleIds":["paths/~1EviPost~1Cancel/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1EviPost~1Cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/EviPost/Cancel","servers":[{"url":"https://api.evicertia.com/v1","description":"Production"},{"url":"https://api.ecertia.com/v1","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviPostCancelRequest","exampleIds":["paths/~1EviPost~1Cancel/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404"],"pointer":"/EviPost/Cancel","href":"evipost/evipostcancel","openApiOperationId":"eviPostCancel","summary":"Cancel a postal communication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com/v1","description":"Production"},{"url":"https://api.ecertia.com/v1","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviPostCancelRequest","exampleIds":["paths/~1EviPost~1Cancel/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviPostCancelRequest","exampleIds":["paths/~1EviPost~1Cancel/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cancellation request accepted for asynchronous processing; cancellation is not yet confirmed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostCancelResponse","exampleIds":["paths/~1EviPost~1Cancel/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviPostCancelResponse","exampleIds":["paths/~1EviPost~1Cancel/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request, such as a malformed UUID. Supply a non-empty UniqueId."},{"code":"401","description":"Authentication failed, or the authenticated account is not the owner of the postal communication."},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authenticated account lacks the required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CanUseCancel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission, or EviPost is not enabled for this account."},"children":[]}]}]}]},{"code":"404","description":"No postal communication with the given UniqueId was found."}],"pointer":"/paths/~1EviPost~1Cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviPostCancelResponse","exampleIds":["paths/~1EviPost~1Cancel/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostCancelResponse","exampleIds":["paths/~1EviPost~1Cancel/post/responses/200/content/application~1json/example"]}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evipost/evipostcancel"}],"panels":[]}]},"httpPath":"/EviPost/Cancel"},{"label":"Request an on-demand affidavit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/products/namirialnotify/apis/oas/evipost-api/evipost/evipostaffidavitrequest","routeSlug":"/products/namirialnotify/apis/oas/evipost-api/evipost/evipostaffidavitrequest","metadata":{"seo":{"title":"Request an on-demand affidavit","description":"The original submitting account can request an affidavit for a submitted Letter or LetterLite before it closes. At Submit, enable AffidavitsOnDemandEnabled and use AdvancedContentOnSubmit, AdvancedContentOnClose, or AdvancedContentOnSubmitAndOnClose. Generation is asynchronous and a configurable limit applies per communication. Registered accepts the flag at Submit but cannot use this operation. The platform skips a queued request if the communication closes or earlier requests reach the limit before processing. In these cases no AffidavitPublished callback is sent for the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"eviPostAffidavitRequest","name":"Request an on-demand affidavit","isWebhook":false,"pointer":"/paths/~1EviPost~1AffidavitRequest/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request an on-demand affidavit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original submitting account can request an affidavit for a submitted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LetterLite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before it closes. At Submit, enable "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AffidavitsOnDemandEnabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdvancedContentOnSubmit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdvancedContentOnClose"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdvancedContentOnSubmitAndOnClose"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Generation is asynchronous and a configurable limit applies per communication. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts the flag at Submit but cannot use this operation. The platform skips a queued request if the communication closes or earlier requests reach the limit before processing. In these cases no AffidavitPublished callback is sent for the request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviPostAffidavitRequest","exampleIds":["paths/~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/EviPostAffidavitRequest","exampleIds":["paths/~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1EviPost~1AffidavitRequest/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/EviPost/AffidavitRequest","servers":[{"url":"https://api.evicertia.com/v1","description":"Production"},{"url":"https://api.ecertia.com/v1","description":"Pre-production / QA"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EviPostAffidavitRequest","exampleIds":["paths/~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403"],"pointer":"/EviPost/AffidavitRequest","href":"evipost/evipostaffidavitrequest","openApiOperationId":"eviPostAffidavitRequest","summary":"Request an on-demand affidavit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.evicertia.com/v1","description":"Production"},{"url":"https://api.ecertia.com/v1","description":"Pre-production / QA"}],"schemaId":"components/schemas/EviPostAffidavitRequest","exampleIds":["paths/~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EviPostAffidavitRequest","exampleIds":["paths/~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Affidavit request queued. Use Query to check which affidavits were generated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostAffidavitResponse","exampleIds":["paths/~1EviPost~1AffidavitRequest/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/EviPostAffidavitResponse","exampleIds":["paths/~1EviPost~1AffidavitRequest/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request or business rule failure","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostError"}},"schemaId":"components/schemas/EviPostError"},{"code":"401","description":"Authentication failed"},{"code":"403","description":"The authenticated account lacks the required API or EviPost permissions."}],"pointer":"/paths/~1EviPost~1AffidavitRequest/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EviPostAffidavitResponse","exampleIds":["paths/~1EviPost~1AffidavitRequest/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostAffidavitResponse","exampleIds":["paths/~1EviPost~1AffidavitRequest/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/EviPostError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EviPostError"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/evipost/evipostaffidavitrequest"}],"panels":[]}]},"httpPath":"/EviPost/AffidavitRequest"}],"content":{"contentType":"group","meta":{"name":"EviPost"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"EviPost","showPageActions":true},{"nodeType":"markdoc","content":"Submit, track, request cancellation of, and retrieve evidence for certified postal communications."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/EviPost/Submit","summary":"Submit a certified postal communication","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evipost/evipostsubmit","deprecated":false},{"title":"/EviPost/Query","summary":"Query certified postal communications (GET)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/evipost/evipostqueryget","deprecated":false},{"title":"/EviPost/Cancel","summary":"Cancel a postal communication","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evipost/evipostcancel","deprecated":false},{"title":"/EviPost/AffidavitRequest","summary":"Request an on-demand affidavit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/evipost/evipostaffidavitrequest","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/EviPostSubmitRequest":{"id":"components/schemas/EviPostSubmitRequest","kind":"json-schema","title":"EviPostSubmitRequest","data":{"type":"object","required":["Document","RecipientName","RecipientAddress"],"properties":{"LookupKey":{"type":"string","description":"Optional identifier set by the issuer. Can be used later to locate the evidence via the Query endpoint.\n"},"Document":{"type":"string","description":"The document or letter to be sent, base64-encoded PDF."},"RecipientName":{"type":"string","description":"Non-blank display name of the recipient.","pattern":"\\S"},"RecipientLegalName":{"type":"string","description":"Legal name or corporate name of the recipient."},"RecipientAddress":{"$ref":"#/components/schemas/EviPostAddress"},"RecipientPhone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recipient phone number. Use + followed by the country code and phone number, with digits only."},"children":[]}]}]}]},"RecipientEmail":{"type":"string","format":"email","description":"Email address of the recipient."},"IssuerName":{"type":"string","description":"Display name of the sender. Supply it explicitly to record it in the evidence."},"IssuerLegalName":{"type":"string","description":"Legal or corporate name of the sender. Supply it explicitly to record it in the evidence."},"IssuerAddress":{"$ref":"#/components/schemas/EviPostAddress"},"IssuerPhone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Issuer phone number. Use + followed by the country code and phone number, with digits only."},"children":[]}]}]}]},"IssuerEmail":{"type":"string","format":"email","description":"Email address of the issuer."},"IssuerComments":{"type":"string","description":"Optional additional comments from the issuer."},"Options":{"$ref":"#/components/schemas/EviPostOptions"}}}},"components/schemas/EviPostAddress":{"id":"components/schemas/EviPostAddress","kind":"json-schema","title":"EviPostAddress","data":{"type":"object","required":["StreetAddress","PostalCode","Locality","Country"],"properties":{"StreetAddress":{"type":"string","description":"Street name and number. Maximum 100 characters for the recipient and 255 for the issuer."},"PostalCode":{"type":"string","description":"Postal code."},"Locality":{"type":"string","description":"City or town."},"Region":{"type":"string","description":"Province or region. Required in RecipientAddress when PostServiceType is Registered. The issuer region must also be present, either supplied in IssuerAddress or filled from the site address.\n"},"Country":{"type":"string","description":"ISO 3166-1 alpha-2 country code (e.g. ES)."},"PostOfficeBoxAddress":{"type":"string","description":"Post office box address, if applicable."}}}},"components/schemas/EviPostOptions":{"id":"components/schemas/EviPostOptions","kind":"json-schema","title":"EviPostOptions","data":{"type":"object","properties":{"PostServiceType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls the type of postal delivery. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sends a certified postal communication equivalent to a burofax (via the national postal operator, Correos); enabling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" receipt, attempt or disposal options or passing non-zero attempts or disposal days returns 400. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sends to a printing and enveloping provider (MRW). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LetterLite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a single-attempt printed letter available only within mainland Spain; omit the attempt and disposal options. Sites billed per submission cannot use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LetterLite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted."},"children":[]}]}]}],"enum":["Registered","Letter","LetterLite"],"default":"Registered"},"PostServiceProfile":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional provider profile for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omit it unless support has given you a profile identifier."},"children":[]}]}]}]},"CertificationLevel":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Legal framework and geographic variant for certification. Supported values include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and their regional variants, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Standard_EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Advanced_EU"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Availability depends on the account. EviPost does not support QERDS certification levels. Supply the level explicitly; the API does not use the Web form’s account default."},"children":[]}]}]}],"enum":["Standard","Advanced","Standard_CO","Standard_CR","Standard_EC","Standard_EU","Standard_MX","Standard_PE","Advanced_CO","Advanced_CR","Advanced_EC","Advanced_EU","Advanced_MX","Advanced_PE"]},"AffidavitProfile":{"type":"string","description":"Controls which affidavits are generated during the process.","enum":["None","Basic","AdvancedContentOnSubmit","AdvancedContentOnClose","AdvancedContentOnSubmitAndOnClose"]},"AffidavitsOnDemandEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set at Submit for an advanced content profile to enable on-demand affidavit requests on an open "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LetterLite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A configurable limit applies per communication. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts the flag at Submit but cannot use AffidavitRequest."},"children":[]}]}]}]},"OnlineRetentionPeriod":{"type":"integer","description":"Online evidence retention in years. Currently 1 year by default.","minimum":1,"maximum":20},"NotaryRetentionPeriod":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to 5 for five years of custody or 0 to disable. Any non-zero value applies five years. Supply "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotaryProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a positive value."},"children":[]}]}]}]},"NotaryProfile":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provisioned notary profile. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotaryRetentionPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is greater than 0; omit otherwise. Use non-empty alphanumeric segments separated by colons, up to 50 characters in total."},"children":[]}]}]}],"pattern":"^[A-Za-z0-9]+(:[A-Za-z0-9]+)*$","maxLength":50},"EvidenceAccessControlMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls how recipients access the evidence record. If omitted, the API uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (no access challenge). Set the method explicitly. When set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EvidenceAccessControlChallenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EvidenceAccessControlChallengeResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be supplied."},"children":[]}]}]}],"enum":["AutoChallenge","Public","Challenge"]},"EvidenceAccessControlChallenge":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Challenge question. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EvidenceAccessControlMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"EvidenceAccessControlChallengeResponse":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Answer to the challenge question. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EvidenceAccessControlMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Challenge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"Language":{"type":"string","description":"Language for the evidence record and generated affidavits. Defaults to the site's configured language when omitted.\n","enum":["en","es","ca","it","pt","pt-BR","fr","de","ro"]},"CostCentre":{"type":"string","description":"Optional billing group identifier. Groups submissions for invoicing and expense allocation.\n"},"EnableDeliveryReceipt":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type only. Enables delivery receipt tracking."},"children":[]}]}]}]},"EnableDeliveryAttempts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": set to true with a positive DeliveryAttemptsNumber."},"children":[]}]}]}]},"DeliveryAttemptsNumber":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a positive number requires EnableDeliveryAttempts: true. The maximum is currently 2 by default."},"children":[]}]}]}],"minimum":0},"CustomFields":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of custom key-value fields attached to the submission. Fields with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IsLookupKey: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are indexed and returned in query results under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LookupKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", concatenated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Do not combine them with a top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LookupKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/EviPostCustomField"}},"PushNotificationUrl":{"type":"string","format":"uri","description":"URL to receive HTTP POST callbacks when the postal communication changes state.\n"},"PushNotificationFilter":{"type":"array","description":"Event names that trigger callbacks. Supply both the URL and a non-empty filter, or omit both. Submit returns 400 if only one is set or if the filter repeats a value. AffidavitPublished is an event, not a state.\n","uniqueItems":true,"items":{"type":"string","enum":["Processed","Dispatched","Sent","Delivered","Closed","Cancelled","Issued","Disposed","AffidavitPublished"]}},"PushNotificationExtraData":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Free-text value included in every callback payload under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AdditionalData.ExtraData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"EnableDisposal":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; set to true with a positive DisposalDaysAmmount."},"children":[]}]}]}]},"DisposalDaysAmmount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": set to 0 for no disposal, or 1 to 15 with EnableDisposal set to true. The field retains its original spelling."},"children":[]}]}]}],"minimum":0,"maximum":15},"OwnerNotificationTemplate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of an enabled custom template used for the issuer's status notification email. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/products/namirialnotify/dev/templates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using communication templates from the API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"OwnerNotificationTemplateValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Key-value pairs supplying values for the user variables declared in OwnerNotificationTemplate."},"LtaStorage":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, the evidence for this transaction is stored in Namirial Archive during post-close processing after tracking reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires LTA to be enabled for the site. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OnlineRetentionPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separately controls online accessibility."},"children":[]}]}]}]}}}},"components/schemas/EviPostCustomField":{"id":"components/schemas/EviPostCustomField","kind":"json-schema","title":"EviPostCustomField","data":{"type":"object","required":["Key","Label","Value","TypeName"],"properties":{"Key":{"type":"string","description":"Identifier of the custom field."},"Label":{"type":"string","description":"Display label for the field."},"Value":{"type":"string","description":"Value of the custom field."},"IsLookupKey":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, this value is indexed and surfaced in query results under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LookupKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"TypeName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field type. Currently only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]}]}]}],"enum":["Text"]},"DefaultValue":{"type":"string"},"DefaultValueIsForced":{"type":"boolean"},"Required":{"type":"boolean"},"ValidationRegex":{"type":"string","description":"Regex expression to validate the field value."},"ValidationMessage":{"type":"string","description":"Message shown when validation fails."},"MaxLength":{"type":"integer","description":"Maximum character length of the field value."}}}},"components/schemas/EviPostSubmitResponse":{"id":"components/schemas/EviPostSubmitResponse","kind":"json-schema","title":"EviPostSubmitResponse","data":{"type":"object","required":["uniqueId"],"properties":{"uniqueId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Unique identifier of the submitted postal communication. Serialized as 32 hexadecimal characters without dashes."}}}},"components/schemas/EviPostQueryResponse":{"id":"components/schemas/EviPostQueryResponse","kind":"json-schema","title":"EviPostQueryResponse","data":{"type":"object","properties":{"totalMatches":{"type":"integer","description":"Total number of records matching the query filters."},"results":{"type":"array","items":{"$ref":"#/components/schemas/EviPostQueryResult"}}}}},"components/schemas/EviPostQueryResult":{"id":"components/schemas/EviPostQueryResult","kind":"json-schema","title":"EviPostQueryResult","data":{"type":"object","description":"Individual query result object. Unlike the request body (which uses PascalCase field names), the v1 EviPost query response serialises field names in camelCase.\n","properties":{"evidenceId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Unique identifier of the postal communication. Serialized as 32 hexadecimal characters without dashes."},"lookupKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lookup key set at submission. If multiple CustomFields were indexed, values are concatenated with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"::"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"recipientName":{"type":"string"},"address":{"type":"object","description":"Recipient postal address. Returned with camelCase field names.","properties":{"streetAddress":{"type":"string"},"postalCode":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code (e.g. ES)."},"postOfficeBoxAddress":{"type":"string"}}},"document":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded original document. Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IncludeDocumentOnResult"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true."},"children":[]}]}]}]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current lifecycle state. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Undelivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" records reported non-delivery but does not itself close tracking. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Registered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with delivery tracking enabled, the platform accepts a later valid delivery report before closure; the operator sequence is unconfirmed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LetterLite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot complete normal closure with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once non-delivery has been recorded. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" workflow configured for disposal can continue to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disposed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a later failure report for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can instead lead to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before closure. Individual delivery attempts are events and do not necessarily change the state. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may appear for transitional internal states; contact support if seen in production responses."},"children":[]}]}]}],"enum":["Draft","Submitted","Processed","Sent","Dispatched","Delivered","Missing","Closed","Issued","Failed","Undelivered","Disposed","Cancelled"]},"stateDate":{"type":"string","format":"date-time","description":"Date of the recorded state."},"lastStateChangeDate":{"type":"string","format":"date-time","description":"Date when the platform last updated the state or online retention expiry."},"outcome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result recorded so far; it may change while the communication is open. Treat this as the final postal result when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Undelivered"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not by itself identify an item awaiting collection or a return-to-sender action. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is listed in the contract but is not supported as the outcome of normal postal closure. A tracking timeout does not automatically assign "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; check the current state with Query and contact support if it appears. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may appear for transitional internal states; contact support if seen in production responses."},"children":[]}]}]}],"enum":["None","Delivered","Dispatched","Acknowledged","Declined","Hindered","Cancelled","Expired","Failed","Sent","Rejected","Undelivered","Disposed"]},"outcomeDate":{"type":"string","format":"date-time","description":"Date assigned to the outcome."},"creationDate":{"type":"string","format":"date-time"},"submittedOn":{"type":"string","format":"date-time"},"processedOn":{"type":"string","format":"date-time"},"dispatchedOn":{"type":"string","format":"date-time"},"sentOn":{"type":"string","format":"date-time"},"deliveredOn":{"type":"string","format":"date-time"},"closedOn":{"type":"string","format":"date-time"},"issuedOn":{"type":"string","format":"date-time","description":"Timestamp when the postal item was issued."},"timeToLive":{"type":"integer","description":"Tracking window in minutes: 50400 for Registered and 21600 for Letter or LetterLite. A timeout does not set the Expired outcome.\n"},"costCentre":{"type":"string","description":"Cost-centre label recorded with the transaction for internal billing allocation."},"onlineRetentionPeriod":{"type":"integer"},"notaryRetentionPeriod":{"type":"integer"},"notaryProfile":{"type":"string"},"sourceChannel":{"type":"string","enum":["Web","Api","Smtp"]},"enableDeliveryReceipt":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. Whether delivery receipt tracking is enabled."},"children":[]}]}]}]},"deliveryAttemptsNumber":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Letter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type. Number of delivery attempts configured before the process ends."},"children":[]}]}]}]},"disposalDaysAmmount":{"type":"integer","description":"Number of days after which an undelivered postal item is disposed of. (Note: the field name retains its original spelling in the API.)\n"},"affidavits":{"type":"array","description":"Affidavit entries. Set IncludeAffidavitsOnResult to true to retrieve metadata. Some deployments embed PDFs unless IncludeAffidavitBlobsOnResult is explicitly false.\n","items":{"$ref":"#/components/schemas/EviPostAffidavit"}}}}},"components/schemas/EviPostAffidavit":{"id":"components/schemas/EviPostAffidavit","kind":"json-schema","title":"EviPostAffidavit","data":{"type":"object","description":"Affidavit metadata and optional legacy Base64 content associated with a postal communication.","properties":{"uniqueId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Unique identifier of the affidavit. Serialized as 32 hexadecimal characters without dashes."},"date":{"type":"string","format":"date-time","description":"Creation timestamp of the affidavit."},"evidenceUniqueId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Unique identifier of the evidence this affidavit belongs to. Serialized as 32 hexadecimal characters without dashes."},"partyUniqueId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Identifier of the related delivery/party, when applicable. Serialized as 32 hexadecimal characters without dashes."},"bytes":{"type":"string","format":"byte","nullable":true,"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded affidavit PDF, populated when blob inclusion is enabled. Send IncludeAffidavitBlobsOnResult=false for metadata only."},"children":[]}]}]}]},"description":{"type":"string","description":"Human-readable description of the affidavit."},"kind":{"type":"string","description":"Technical identifier of the affidavit kind, when available."},"additionalData":{"type":"object","description":"Additional affidavit metadata as key-value pairs.","additionalProperties":{"type":"string"}}}}},"components/schemas/EviPostAffidavitRequest":{"id":"components/schemas/EviPostAffidavitRequest","kind":"json-schema","title":"EviPostAffidavitRequest","data":{"type":"object","required":["UniqueId"],"properties":{"UniqueId":{"type":"string","format":"uuid","description":"Unique ID of the EviPost to generate an affidavit for."},"IncludeDocument":{"type":"boolean","description":"If true, the document is included in the affidavit."},"IncludeEvents":{"type":"boolean","description":"If true, detailed event information is included in the affidavit.\n"}}}},"components/schemas/EviPostAffidavitResponse":{"id":"components/schemas/EviPostAffidavitResponse","kind":"json-schema","title":"EviPostAffidavitResponse","data":{"type":"object","required":["requestId"],"properties":{"requestId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"Identifier of the affidavit generation request, serialized as 32 hexadecimal characters without dashes."}}}},"components/schemas/EviPostError":{"id":"components/schemas/EviPostError","kind":"json-schema","title":"EviPostError","data":{"type":"object","properties":{"responseStatus":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}},"components/schemas/EviPostCancelRequest":{"id":"components/schemas/EviPostCancelRequest","kind":"json-schema","title":"EviPostCancelRequest","data":{"type":"object","required":["UniqueId"],"properties":{"UniqueId":{"type":"string","format":"uuid","description":"The unique ID of the postal communication to cancel, as returned at submission."}}}},"components/schemas/EviPostCancelResponse":{"id":"components/schemas/EviPostCancelResponse","kind":"json-schema","title":"EviPostCancelResponse","data":{"type":"object","properties":{"uniqueId":{"type":"string","pattern":"^[0-9a-fA-F]{32}$","description":"The unique ID of the communication whose cancellation request was accepted; cancellation is not yet confirmed. Serialized as 32 hexadecimal characters without dashes."}}}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"object","properties":{"X-Evi-IdempotencyStatus":{"type":"string","enum":["New"],"description":"Idempotency outcome for the submission request."}}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"object","properties":{"X-Evi-IdempotencyStatus":{"type":"string","enum":["Replay"],"description":"Idempotency outcome for the submission request."}}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"object","properties":{"X-Evi-IdempotencyStatus":{"type":"string","enum":["Conflict"],"description":"Idempotency outcome for the submission request."}}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","enum":["Draft","Submitted","Processed","Sent","Dispatched","Delivered","Missing","Closed","Issued","Failed","Undelivered","Disposed","Cancelled"]},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"string","enum":["None","Delivered","Dispatched","Acknowledged","Declined","Hindered","Cancelled","Expired","Failed","Sent","Rejected","Undelivered","Disposed"]},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","enum":["CreationDate"]},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_9"}},"exampleStore":{"paths/~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost":{"value":{"LookupKey":"a2R4S25kWiu79fsbubSXkw==","Document":"<base64-encoded PDF>","RecipientName":"Juan Valido","RecipientLegalName":"Juan Valido","RecipientAddress":{"StreetAddress":"Gran Via 74, 5 A","PostalCode":"28014","Locality":"Madrid","Region":"Madrid","Country":"ES"},"RecipientPhone":"+34677000111","RecipientEmail":"recipient@example.com","IssuerName":"Pedro Comprador","IssuerLegalName":"Pedro Valido","IssuerAddress":{"StreetAddress":"C/ Gran Via, 1, 1-A","PostalCode":"28001","Locality":"Madrid","Region":"Madrid","Country":"ES"},"IssuerPhone":"+34677888777","IssuerEmail":"pedro.comprador@example.com","IssuerComments":"Sending in March.","Options":{"PostServiceType":"Registered","Language":"es","CertificationLevel":"Advanced_EU","AffidavitProfile":"AdvancedContentOnSubmit","AffidavitsOnDemandEnabled":false,"OnlineRetentionPeriod":1,"NotaryRetentionPeriod":5,"NotaryProfile":"notary:profile","EvidenceAccessControlMethod":"AutoChallenge","CostCentre":"dept-legal","PushNotificationUrl":"https://your-server.example.com/callbacks/evipost","PushNotificationFilter":["Processed","Sent","Delivered","Closed"],"PushNotificationExtraData":"{\"myId\": \"order-12345\"}"}},"key":"registeredPost","summary":"Registered postal communication","id":"paths/~1EviPost~1Submit/post/requestBody/content/application~1json/examples/registeredPost"},"paths/~1EviPost~1Submit/post/responses/200/content/application~1json/example":{"value":{"uniqueId":"69819c3e0c0e42b3a792a33b014a13a2"},"id":"paths/~1EviPost~1Submit/post/responses/200/content/application~1json/example"},"paths/~1EviPost~1Query/get/responses/200/content/application~1json/example":{"value":{"results":[{"evidenceId":"3977d143a6cb4642abc6a33b016cbec2","lookupKey":"a2R4S25kWiu79fsbubSXkw==","recipientName":"Juan Valido","address":{"streetAddress":"Gran Via 74, 5 A","postalCode":"28014","locality":"Madrid","region":"Madrid","country":"ES"},"state":"Sent","stateDate":"2026-01-15T10:00:07Z","lastStateChangeDate":"2026-01-15T10:00:11Z","outcome":"Sent","outcomeDate":"2026-01-15T10:00:07Z","creationDate":"2026-01-15T10:00:00Z","submittedOn":"2026-01-15T10:00:00Z","processedOn":"2026-01-15T10:00:03Z","sentOn":"2026-01-15T10:00:07Z","timeToLive":50400,"costCentre":"dept-legal","affidavits":[{"uniqueId":"000c1f7042aca3ea149f943879726a87","date":"2026-01-15T10:00:12Z","evidenceUniqueId":"3977d143a6cb4642abc6a33b016cbec2","description":"Certification of postal communication"}]}],"totalMatches":1},"id":"paths/~1EviPost~1Query/get/responses/200/content/application~1json/example"},"paths/~1EviPost~1Cancel/post/requestBody/content/application~1json/example":{"value":{"UniqueId":"69819c3e-0c0e-42b3-a792-a33b014a13a2"},"id":"paths/~1EviPost~1Cancel/post/requestBody/content/application~1json/example"},"paths/~1EviPost~1Cancel/post/responses/200/content/application~1json/example":{"value":{"uniqueId":"69819c3e0c0e42b3a792a33b014a13a2"},"id":"paths/~1EviPost~1Cancel/post/responses/200/content/application~1json/example"},"paths/~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example":{"value":{"UniqueId":"87ffa214-e773-4bd5-9b8d-a8ef00fd80f8","IncludeDocument":true,"IncludeEvents":true},"id":"paths/~1EviPost~1AffidavitRequest/post/requestBody/content/application~1json/example"},"paths/~1EviPost~1AffidavitRequest/post/responses/200/content/application~1json/example":{"value":{"requestId":"79726a87000c1f7042aca3ea149f9438"},"id":"paths/~1EviPost~1AffidavitRequest/post/responses/200/content/application~1json/example"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"}},"specVersion":"3.0.3","servers":[{"url":"https://api.evicertia.com/v1","description":"Production"},{"url":"https://api.ecertia.com/v1","description":"Pre-production / QA"}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/products/namirialnotify/apis/oas/evipost-api.json?download"},{"url":"/_bundle/products/namirialnotify/apis/oas/evipost-api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"EviPost API","description":"REST API for submitting and querying certified physical postal communications through Namirial Notify, with configurable certification and custody, asynchronous affidavit generation, and event callbacks. For the public Namirial Notify API environments, this V1 service is exposed under the `/v1` base path. The `servers` entries below already include that public base path. Some lower-level technical artifacts may show the underlying route without the prefix. For customer integrations, use the public URLs produced by this specification.\n"}},"baseSlug":"/products/namirialnotify/apis/oas/evipost-api","routesMapping":{}}