{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/namirialnotify/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"EviMail 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":"evimail-api","__idx":0},"children":["EviMail API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The EviMail API lets you submit certified emails, query the status of previously submitted messages, and request on-demand affidavits for eligible transactions. 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, callback semantics, and integration guidance, see the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evimail"},"children":["EviMail 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/EviMail/Submit"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/EviMail/Query"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/EviMail/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 ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/api-documentation#environments"},"children":["API documentation"]},"."]},{"$$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":["The authenticated account must also hold the appropriate API permission grants. Contact your Namirial Notify account manager to confirm provisioning if you receive unexpected ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}," responses."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For credential handling, callback hardening, and production security checks, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/security-best-practices"},"children":["Security and authentication"]},"."]},{"$$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":["EviMail Submit supports idempotent submission. Include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyToken"]}," header with a unique value per logical operation (a UUID is recommended)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The server signals the idempotency outcome in the response header ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyStatus"]},", which takes one of these values:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"X-Evi-IdempotencyStatus"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyStatus"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["New"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First time the token is seen. The request executes normally and the response is cached for future replays."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Replay"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The token matches a cached ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}," submission. The original response body is returned, with HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]},". The message is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," resubmitted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Conflict"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Another request with the same token is currently in flight. The response is HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409 Conflict"]},". Back off and retry the same Submit with the same token."]}]}]}]}]},{"$$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":"endpoints","__idx":4},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"submit-a-certified-email","__idx":5},"children":["Submit a certified email"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /v1/EviMail/Submit\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submits a new certified email. On success, returns an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eviId"]}," that uniquely identifies the submitted message 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":["Subject"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Body"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Recipient"]}," (with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EmailAddress"]},")."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Optional fields include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["From"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReplyTo"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DisableSenderHeader"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CarbonCopy"]}," (array of recipients), and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Attachments"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Recipient.LegalName"]}," is also optional."]},{"$$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":["Email accepted. Body contains ",{"$$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. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#idempotency"},"children":["Idempotency"]}," above."]}]},{"$$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 authenticated account lacks the required API permission, has specified a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["From"]}," address that is not permitted for this account, or has attempted to set a restricted request header."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409 Conflict"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Another Submit with the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyToken"]}," is currently in flight. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#idempotency"},"children":["Idempotency"]}," above."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example request:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"POST /v1/EviMail/Submit HTTP/1.1\nAuthorization: Basic <base64(username:password)>\nContent-Type: application/json\nX-Evi-IdempotencyToken: 550e8400-e29b-41d4-a716-446655440000\n\n{\n  \"LookupKey\": \"ORDER-12345\",\n  \"Subject\": \"Your certified policy update\",\n  \"Body\": \"<html><body><p>Please review the attached policy update.</p></body></html>\",\n  \"IssuerName\": \"Acme Corp\",\n  \"Recipient\": {\n    \"LegalName\": \"Alice Martin\",\n    \"EmailAddress\": \"alice@example.com\"\n  },\n  \"Options\": {\n    \"CertificationLevel\": \"Advanced_EU\",\n    \"TimeToLive\": 10080,\n    \"PushNotificationUrl\": \"https://your-endpoint.example.com/callbacks/evimail\",\n    \"PushNotificationFilter\": [\"Delivered\", \"Closed\", \"AffidavitPublished\"],\n    \"AffidavitKinds\": [\"Submitted\", \"TransmissionResult\", \"DeliveryResult\", \"Closed\"]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example response (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]},"):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"eviId\": \"2aca3ea1-49f9-4387-9726-a87000c1f704\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-certified-emails","__idx":6},"children":["Query certified emails"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v1/EviMail/Query\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a list of certified emails 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":["WithLinkedId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string (UUID)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by linked ID."]}]},{"$$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."]}]},{"$$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."]}]},{"$$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":["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":["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":["IncludeAffidavits"]}]},{"$$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":["IncludeAttachments"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Include attachment metadata in results."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," is omitted, the API uses a default limit of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]},". The default becomes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["25"]}," when the request includes affidavit or attachment metadata."]},{"$$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":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-an-on-demand-affidavit","__idx":7},"children":["Request an on-demand affidavit"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /v1/EviMail/AffidavitRequest\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Generates a custom affidavit for a previously submitted EviMail. To use this endpoint, the original submit request must have included ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitKinds"]}," with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnDemand"]}," value. The communication must still be eligible for on-demand affidavits."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requests are rejected when the communication is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Draft"]},", already ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]},", not enabled for on-demand affidavits, over the configured maximum request count, or requested by a non-owner."]},{"$$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 EviMail to generate an affidavit for."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeBody"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Include the email body in the affidavit."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAttachments"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional. Include email attachments in the affidavit. Attachments must have been submitted with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeOnAffidavits: true"]},"."]}]},{"$$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\": \"...\" }"]},". The affidavit is generated asynchronously."]}]},{"$$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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]},"."]}]},{"$$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":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"batch-operations","__idx":8},"children":["Batch operations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Batch operations let you send the same certified email to many recipients as a single managed job."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[":::note Base path"," ","The batch endpoints are part of the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["v2"]}," API and live under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/EviMail/Batches"]}," base path — not under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1"]}," base path used by the rest of the EviMail API."," ",":::"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The typical workflow is:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create"]}," an empty batch with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Description"]}," — you receive a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Set the body"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT .../Body"]},") — the HTML email content."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add recipients"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST .../Recipients"]},") — uploaded as a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text/csv"]}," file."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(Optional)"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add attachments"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST .../Attachments"]},") — uploaded as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["multipart/form-data"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Configure options"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH .../{BatchId}"]},") — certification level, commitment, callbacks, scheduling, and so on. Also set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Subject"]}," here."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Start processing"]}," by setting the batch ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["State"]}," (via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},") once the batch is ready."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Poll ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET .../{BatchId}"]}," to follow progress (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SentCount"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FailedCount"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ProgressPercentage"]},"). Batch lifecycle states are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Draft"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Submitted"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Scheduled"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Processing"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Processed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Invalid"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[":::note HTTP QUERY method"," ","The two list endpoints (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query batches"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query batch recipients"]},") are implemented with the HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["QUERY"]}," method and accept their filters in a JSON request body. Because OpenAPI cannot express the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["QUERY"]}," method, they are documented as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," with the filter fields shown as query parameters. In practice, send the request with the HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["QUERY"]}," verb and the fields in a JSON body."," ",":::"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-an-email-batch","__idx":9},"children":["Create an email batch"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /v2/EviMail/Batches\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates a new, empty batch. Only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Description"]}," is required; the body, recipients, attachments, and options are set with the subsequent batch endpoints."]},{"$$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":["Description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required. Human-readable batch description (max 255 chars)."]}]}]}]}]},{"$$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":["{ \"BatchId\": \"<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."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-email-batches","__idx":10},"children":["Query email batches"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"QUERY /v2/EviMail/Batches\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Lists email batches owned by the caller (or the caller's site), with cursor pagination. Filters are sent in a JSON request body: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["States"]}," (array), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cursor"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," (required, 1–100), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SortBy"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LastUpdated"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ScheduledFor"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["StartedOn"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SortOrder"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ascending"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Descending"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Direction"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Forward"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Backward"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TextSearch"]},"."]},{"$$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":["{ \"Cursor\": \"...\", \"HasMoreResults\": bool, \"Results\": [...] }"]},"."]}]},{"$$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":["Malformed request."]}]},{"$$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":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-an-email-batch","__idx":11},"children":["Get an email batch"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v2/EviMail/Batches/{BatchId}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves the full state of a batch, including its configured email template (nested ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EviMail"]},") and processing progress."]},{"$$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 the full batch object."]}]},{"$$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":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," is missing or a default (empty) 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."]}]},{"$$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 batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"update-an-email-batch","__idx":12},"children":["Update an email batch"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"PATCH /v2/EviMail/Batches/{BatchId}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Updates batch metadata and the email template options. All fields are optional; only the fields supplied are changed. Setting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["State"]}," transitions the batch; setting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ScheduledDate"]}," schedules it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body (all fields optional):"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Subject"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ScheduledDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["State"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["From"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DisableSenderHeader"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReplyTo"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeToLive"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CostCentre"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitKinds"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Language"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitLanguage"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnlineRetentionPeriod"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LtaStorage"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationExtraData"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CommitmentOptions"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CommitmentCommentsAllowed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RejectReasons"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AcceptReasons"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequireRejectReason"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RequireAcceptReason"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryAppearance"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchPushNotificationUrl"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OwnerNotificationTemplate"]},"."]},{"$$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":["Batch updated."]}]},{"$$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."]}]},{"$$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":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-an-email-batch","__idx":13},"children":["Delete an email batch"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /v2/EviMail/Batches/{BatchId}\n"},"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":"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":["204 No Content"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Batch deleted."]}]},{"$$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":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"set-the-batch-body","__idx":14},"children":["Set the batch body"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"PUT /v2/EviMail/Batches/{BatchId}/Body\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sets the HTML body of the email for this batch. The body is sent as the raw request payload with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type: text/html"]},", not as a JSON field. Set the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Subject"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH .../{BatchId}"]},"."]},{"$$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":["202 Accepted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Body accepted and queued for update. Poll ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET .../{BatchId}"]}," to check status."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The request has no valid body."]}]},{"$$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":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"add-batch-recipients","__idx":15},"children":["Add batch recipients"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /v2/EviMail/Batches/{BatchId}/Recipients\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Adds recipients by uploading a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text/csv"]}," file (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type: text/csv"]},"). The CSV uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[";"]}," as the column separator."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Mandatory columns:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["emailaddress"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["legalname"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional columns:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupkey"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayname"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["evidenceaccesscontrolchallenge"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["evidenceaccesscontrolchallengeresponse"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom fields:"]}," add extra columns prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["*"]}," (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["*orderid"]},"); they are surfaced per recipient as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ExtraFields"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example request body:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"emailaddress;legalname;displayname;*orderid\njane@example.com;Acme Corp;Jane Doe;ORD-001\njohn@example.com;Beta Ltd;John Roe;ORD-002\n"},"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":"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":["Recipients accepted. No response body is returned."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The payload is empty or the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," is not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text/csv"]},"."]}]},{"$$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":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409 Conflict"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The recipient list failed validation (for example, missing mandatory columns)."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-batch-recipients","__idx":16},"children":["Query batch recipients"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"QUERY /v2/EviMail/Batches/{BatchId}/Recipients\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Lists the recipients of a batch, with cursor pagination. Filters are sent in a JSON request body: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cursor"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," (1–1000), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SortDirection"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ascending"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Descending"]},")."]},{"$$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":["{ \"Cursor\": \"...\", \"Results\": [...] }"]},". Each result includes the recipient fields and, once processed, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceUniqueId"]}," of the generated email."]}]},{"$$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":["Malformed request."]}]},{"$$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":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-all-batch-recipients","__idx":17},"children":["Delete all batch recipients"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /v2/EviMail/Batches/{BatchId}/Recipients\n"},"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":"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":["204 No Content"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipients removed."]}]},{"$$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":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"add-a-batch-attachment","__idx":18},"children":["Add a batch attachment"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /v2/EviMail/Batches/{BatchId}/Attachments\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Adds a single attachment as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["multipart/form-data"]},". The attachment is included in every email generated from the batch. Send the file in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content"]}," part; the remaining metadata fields (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DisplayName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filename"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContentId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MimeType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContentDescription"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContentDisposition"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContentLocation"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContentEncoding"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeOnAffidavits"]},") are optional form 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":"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":["{ \"AttachmentId\": \"<uuid>\" }"]},"."]}]},{"$$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":["No file was supplied, or more than one file was supplied."]}]},{"$$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":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-batch-attachments","__idx":19},"children":["List batch attachments"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v2/EviMail/Batches/{BatchId}/Attachments\n"},"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":"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 an array of attachment metadata (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DisplayName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FileName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MimeType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Size"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContentEncoding"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContentId"]},")."]}]},{"$$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":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-all-batch-attachments","__idx":20},"children":["Delete all batch attachments"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /v2/EviMail/Batches/{BatchId}/Attachments\n"},"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":"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":["204 No Content"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attachments removed."]}]},{"$$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":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"download-a-batch-attachment","__idx":21},"children":["Download a batch attachment"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}\n"},"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":"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":["Attachment content (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/octet-stream"]},")."]}]},{"$$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":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No attachment or batch with the given IDs was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-a-batch-attachment","__idx":22},"children":["Delete a batch attachment"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}\n"},"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":"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":["204 No Content"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attachment removed."]}]},{"$$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":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No attachment or batch with the given IDs was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"states-and-outcomes","__idx":23},"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#evimail-evidence-lifecycle"},"children":["EviMail evidence lifecycle"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["States"]}," represent the current step in the message 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":["Message is being prepared."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["New"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message has been accepted by the platform."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message has been validated, certified, and is ready for sending."]}]},{"$$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":["Sending has been requested; the message is ready for the sender component."]}]},{"$$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":["The recipient's mail server accepted the message."]}]},{"$$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":["Delivery confirmation was received."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipient opened the message (where supported and configured)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Replied"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipient replied to the message (where configured)."]}]},{"$$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":["Message lifecycle is complete."]}]},{"$$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 recoverable processing or delivery failure occurred. The platform may retry or advance to a later state."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Outcomes"]}," represent the overall result of the certification 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":"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":["Certified"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message certified with the configured certification level."]}]},{"$$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":["Message was sent."]}]},{"$$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":["Message was delivered."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipient opened the message."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accepted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipient explicitly accepted the message."]}]},{"$$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 explicitly rejected the message."]}]},{"$$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":["Delivery failed permanently."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-request-fields","__idx":24},"children":["Key request fields"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"subject","__idx":25},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Subject"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The email subject line. Maximum 1024 characters. Non-printable control characters are not accepted."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"body","__idx":26},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Body"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The HTML body of the certified email. Accepts HTML content. Maximum 10 MB."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"issuername","__idx":27},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The legal name or identifier for the sending organisation, used in the certified communication record. Maximum 50 characters."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"lookupkey","__idx":28},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your own correlation key. Maximum 35 characters. Filterable in Query. No uniqueness is enforced server-side — make it unique within your own domain."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"certificationlevel","__idx":29},"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"]},", and other country-specific codes. The values available on your account depend on your subscription and configuration — confirm the enabled levels with your Namirial Notify contact or refer to the OpenAPI spec for the machine-readable enum."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"timetolive","__idx":30},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeToLive"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The time in minutes during which the platform will attempt delivery before the message expires. Range: 60–86,400 (1 hour to 60 days)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"language","__idx":31},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Language"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The language used for notification emails sent to the recipient. Accepted values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ca"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["de"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["es"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fr"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["it"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pt"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pt-BR"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ro"]},". Defaults to the account's configured language when omitted."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"affidavitlanguage","__idx":32},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitLanguage"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The language of generated affidavit PDFs. Accepted values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ca"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["de"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["es"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fr"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["it"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pt"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pt-BR"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ro"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["el"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"carboncopy","__idx":33},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CarbonCopy"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An array of additional recipients (each with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Name"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EmailAddress"]},") to receive a copy of the email. Carbon copy recipients are recorded in the transaction but do not generate independent evidence events."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"attachments","__idx":34},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Attachments"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An array of files to attach to the email. Each attachment requires a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filename"]}," and base64-encoded ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Data"]},", and optionally a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DisplayName"]},", content-metadata fields (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContentId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MimeType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContentDescription"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContentDisposition"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContentLocation"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContentEncoding"]},"), and an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Attributes"]}," array of key-value pairs. Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeOnAffidavits"]}," attribute key with value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"true\""]}," to reference the attachment in generated affidavits (PDF attachments only)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Limits: maximum 15 attachments per submission; maximum 8 MB per attachment; maximum 25 MB total across all attachments."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"pushnotificationfilter","__idx":35},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An array of state names that trigger a callback to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]},". Valid values for EviMail: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Replied"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]},", ",{"$$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 message completes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"pushnotificationextradata","__idx":36},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationExtraData"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A free-text string echoed back inside every callback for this communication as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData.ExtraData"]},". Maximum 1024 characters. Use it to pass correlation data your system needs to route the notification without looking up the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eviId"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"affidavitkinds","__idx":37},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitKinds"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Preferred way to select the evidence events for which affidavits should be generated. Supported values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Submitted"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SubmittedAdvanced"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransmissionResult"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryResult"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Committed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CommittedAdvanced"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ClosedAdvanced"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Complete"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CompleteAdvanced"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnDemand"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Event"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To enable on-demand affidavits via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/EviMail/AffidavitRequest"]},", include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnDemand"]}," in this array."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"deliveryappearance","__idx":38},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryAppearance"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Controls the visual appearance of the notification page shown to the recipient. Accepted values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Certified"]}," (default, shows the standard Namirial Notify branded delivery UI) or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AsIs"]}," (plain appearance without certification branding). EviNotice exposes the same concept through a field named ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NotificationLayout"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"evidenceaccesscontrolmethod","__idx":39},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlMethod"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Controls how recipients access the evidence. Supported values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Public"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Challenge"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AutoChallenge"]},". When omitted, the account's configured default method applies."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Challenge"]}," requires the corresponding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlChallenge"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlChallengeResponse"]}," fields to be present. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AutoChallenge"]}," uses a platform-generated challenge based on known recipient data and does not require those fields."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"commitment-reason-fields","__idx":40},"children":["Commitment reason fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CommitmentOptions"]},", accept/reject reason fields are only valid when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CommitmentCommentsAllowed"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},". Accept-only reason fields are not valid with reject-only mode, and reject-only reason fields are not valid with accept-only mode. EviNotice exposes the same behaviour through a field named ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CommitmentChoice"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-responses","__idx":41},"children":["Error responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit and AffidavitRequest endpoints return a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," object for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}," failures:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"responseStatus\": {\n    \"errorCode\": \"ValidationError\",\n    \"message\": \"Validation failed for the submitted request.\",\n    \"errors\": [\n      {\n        \"errorCode\": \"NotEmpty\",\n        \"fieldName\": \"Body\",\n        \"message\": \"Body must not be empty.\"\n      },\n      {\n        \"errorCode\": \"MaximumLength\",\n        \"fieldName\": \"LookupKey\",\n        \"message\": \"LookupKey must not exceed 35 characters.\"\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," is an array of field-level validation failures. Each entry includes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}," that failed, an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorCode"]}," identifying the rule, and a human-readable ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]},". Fix each reported field and retry with a new idempotency token."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"openapi-specification","__idx":42},"children":["OpenAPI specification"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The OpenAPI 3.0.3 specification for the EviMail API provides a machine-readable definition of the documented service endpoints, request and response schemas, authentication method, and error responses. Some legacy or account-gated fields may still require source confirmation or Namirial support guidance before use."]},{"$$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/EviMail/Submit"]},") — detailed request and response schemas, 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/EviMail/Query"]},") — pagination parameters, filtering options, 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/EviMail/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"]}," — EviMail V1 endpoints use service-style error responses with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," object for validation and business-rule failures"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data types"]}," — schema definitions for documented messages, recipients, attachments, and affidavits"]}]},{"$$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/evimail-api"},"children":["View OpenAPI spec →"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":43},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evimail"},"children":["EviMail"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evisms-api"},"children":["EviSMS 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/evipost-api"},"children":["EviPost API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/api-documentation"},"children":["API documentation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/callbacks"},"children":["Callbacks and webhooks"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/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":"EviMail API","id":"evimail-api","depth":1},{"value":"Environments","id":"environments","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Idempotency","id":"idempotency","depth":2},{"value":"Endpoints","id":"endpoints","depth":2},{"value":"Submit a certified email","id":"submit-a-certified-email","depth":3},{"value":"Query certified emails","id":"query-certified-emails","depth":3},{"value":"Request an on-demand affidavit","id":"request-an-on-demand-affidavit","depth":3},{"value":"Batch operations","id":"batch-operations","depth":2},{"value":"Create an email batch","id":"create-an-email-batch","depth":3},{"value":"Query email batches","id":"query-email-batches","depth":3},{"value":"Get an email batch","id":"get-an-email-batch","depth":3},{"value":"Update an email batch","id":"update-an-email-batch","depth":3},{"value":"Delete an email batch","id":"delete-an-email-batch","depth":3},{"value":"Set the batch body","id":"set-the-batch-body","depth":3},{"value":"Add batch recipients","id":"add-batch-recipients","depth":3},{"value":"Query batch recipients","id":"query-batch-recipients","depth":3},{"value":"Delete all batch recipients","id":"delete-all-batch-recipients","depth":3},{"value":"Add a batch attachment","id":"add-a-batch-attachment","depth":3},{"value":"List batch attachments","id":"list-batch-attachments","depth":3},{"value":"Delete all batch attachments","id":"delete-all-batch-attachments","depth":3},{"value":"Download a batch attachment","id":"download-a-batch-attachment","depth":3},{"value":"Delete a batch attachment","id":"delete-a-batch-attachment","depth":3},{"value":"States and outcomes","id":"states-and-outcomes","depth":2},{"value":"Key request fields","id":"key-request-fields","depth":2},{"value":"Subject","id":"subject","depth":3},{"value":"Body","id":"body","depth":3},{"value":"IssuerName","id":"issuername","depth":3},{"value":"LookupKey","id":"lookupkey","depth":3},{"value":"CertificationLevel","id":"certificationlevel","depth":3},{"value":"TimeToLive","id":"timetolive","depth":3},{"value":"Language","id":"language","depth":3},{"value":"AffidavitLanguage","id":"affidavitlanguage","depth":3},{"value":"CarbonCopy","id":"carboncopy","depth":3},{"value":"Attachments","id":"attachments","depth":3},{"value":"PushNotificationFilter","id":"pushnotificationfilter","depth":3},{"value":"PushNotificationExtraData","id":"pushnotificationextradata","depth":3},{"value":"AffidavitKinds","id":"affidavitkinds","depth":3},{"value":"DeliveryAppearance","id":"deliveryappearance","depth":3},{"value":"EvidenceAccessControlMethod","id":"evidenceaccesscontrolmethod","depth":3},{"value":"Commitment reason fields","id":"commitment-reason-fields","depth":3},{"value":"Error responses","id":"error-responses","depth":2},{"value":"OpenAPI specification","id":"openapi-specification","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"title":"EviMail API","description":"REST API reference for EviMail — submit, query, and request on-demand affidavits for certified emails through Namirial Notify.","layout":"doc","outline":"deep","keywords":["evimail api","certified email api","email submit","email query","namirial notify api","rest api"],"seo":{"title":"EviMail API"}},"lastModified":"2026-08-03T09:35:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/namirialnotify/apis/evimail-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}