# Namirial Notify APIs

Unified OpenAPI reference for the Namirial Notify service APIs. This specification aggregates EviNotice, EviMail, EviSMS, EviSign, EviPost, and shared affidavit and attachment download endpoints. EviNotice, EviMail, and EviSMS each group their single-message and batch operations together. In the public Namirial Notify API environments, single-message operations for EviMail, EviSMS, and EviPost use the `/v1` base path. EviMail and EviSMS batch operations use `/v2/EviMail/Batches` and `/v2/EviSms/Batches`, respectively. EviSign issuer operations use `/v1/evisign`; Bundle uses `/v2/evisign/{Id}/bundle`. SignLink overrides the server to the application host and uses `/EviSign/SignLink`. Some lower-level technical artifacts may show those V1 routes without the prefix. For customer integrations, use the public paths shown in this specification. For the public Namirial Notify API environments, EviNotice routes use the `/v2` base path. The legacy `/api/v2/...` form is still accepted for backward compatibility.

Version: 1.0

## Servers

Production
```
https://api.evicertia.com
```

Pre-production / QA
```
https://api.ecertia.com
```

## Security

### basicAuth

Type: http
Scheme: basic

## Download OpenAPI description

 - [Namirial Notify APIs](https://docs.namirial.app/_bundle/products/namirialnotify/apis/oas/namirialnotify-api.yaml)

## EviNotice

 - [POST /v2/EviNotice/Submit](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticesubmit.md)
 - [GET /v2/EviNotice/{Id}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeget.md)
 - [POST /v2/EviNotice/Query](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticequery.md): Use State Closed to find notices that have reached the only terminal state. Outcome then identifies the final recorded result. A notice can close with Outcome Received when link access was recorded an
 - [GET /v2/EviNotice/{Id}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeattachmentsdownload.md)
 - [GET /v2/EviNotice/{Id}/Affidavits](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitsdownload.md)
 - [GET /v2/EviNotice/Affidavits/{Id}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitdownload.md)
 - [POST /v2/EviNotice/Affidavits/Request](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitrequest.md): Generates a custom affidavit for a previously submitted EviNotice. The original submit request must have included `AffidavitKinds` with the `OnDemand` value. The notice must still be eligible — not `D
 - [POST /v2/EviNotice/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchcreate.md): Creates a new, empty notice batch. Only a `Description` is required at creation; the body, recipients, attachments, and options are set with the subsequent batch endpoints. Returns the `BatchId` used
 - [GET /v2/EviNotice/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchesquery.md): Lists notice batches owned by the caller (or the caller's site), with cursor pagination. **This endpoint uses the HTTP `QUERY` method, not GET.** OpenAPI cannot express the `QUERY` method, so it is sh
 - [GET /v2/EviNotice/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchget.md): Retrieves the full state of a batch, including its configured notice template and processing progress.
 - [PATCH /v2/EviNotice/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchpatch.md): Updates batch metadata and the notice template options. All fields are optional; only the fields supplied are changed. Setting `State` transitions the batch (for example, to start processing or schedu
 - [DELETE /v2/EviNotice/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchdelete.md): Removes a previously created batch.
 - [PUT /v2/EviNotice/Batches/{BatchId}/Body](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchbodyput.md): Sets the HTML body of the notice for this batch. The body is sent as the raw request payload (HTML), not as a JSON field. Use `PATCH .../{BatchId}` to set the `Subject`.
 - [POST /v2/EviNotice/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchrecipientspost.md): Adds recipients to the batch by uploading a `text/csv` file. The CSV uses `;` as the column separator. Mandatory columns: `address`, `legalname`. Optional columns: `lookupkey`, `displayname`, `custody
 - [GET /v2/EviNotice/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchrecipientsquery.md): Lists the recipients of a batch, with cursor pagination. **This endpoint uses the HTTP `QUERY` method, not GET.** OpenAPI cannot express the `QUERY` method, so it is shown here as a `GET` with the fil
 - [DELETE /v2/EviNotice/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchrecipientsdelete.md): Removes all recipients from the batch.
 - [POST /v2/EviNotice/Batches/{BatchId}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentspost.md): Adds a single attachment to the batch by uploading it as `multipart/form-data`. The attachment is included in every notice generated from the batch.
 - [GET /v2/EviNotice/Batches/{BatchId}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentsget.md): Returns metadata for all attachments configured on the batch.
 - [DELETE /v2/EviNotice/Batches/{BatchId}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentsdelete.md): Removes all attachments from the batch.
 - [GET /v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentget.md): Downloads the binary content of a single batch attachment.
 - [DELETE /v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentdelete.md): Removes a single attachment from the batch.
## EviMail

 - [POST /v1/EviMail/Submit](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailsubmit.md)
 - [GET /v1/EviMail/Query](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailqueryget.md)
 - [POST /v1/EviMail/AffidavitRequest](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailaffidavitrequest.md): Generates a custom affidavit for a previously submitted EviMail. The original Submit request must have included `AffidavitKinds` containing `OnDemand`, and the communication must still be eligible for
 - [POST /v2/EviMail/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchcreate.md): Creates a new, empty email batch. Only a `Description` is required at creation; the body, recipients, attachments, and options are set with the subsequent batch endpoints. Returns the `BatchId` used b
 - [GET /v2/EviMail/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchesquery.md): Lists batches submitted by the authenticated user in the current site, with cursor pagination. **This endpoint uses the HTTP `QUERY` method, not GET.** OpenAPI cannot express the `QUERY` method, so it
 - [GET /v2/EviMail/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchget.md): Retrieves the full state of a batch, including its configured email template and processing progress.
 - [PATCH /v2/EviMail/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchpatch.md): Updates batch metadata and email template options. To submit a Draft or Invalid batch, send State Submitted and a future UTC ScheduledDate in the same request. To return a Submitted or Scheduled batch
 - [DELETE /v2/EviMail/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchdelete.md): Removes a previously created batch.
 - [PUT /v2/EviMail/Batches/{BatchId}/Body](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchbodyput.md): Sets the HTML body of the email for this batch. The body is sent as the raw request payload (HTML), not as a JSON field. Use `PATCH .../{BatchId}` to set the `Subject`.
 - [POST /v2/EviMail/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchrecipientspost.md): Replaces the recipient list of an editable batch with a raw CSV upload. Send exactly `Content-Type: text/csv` without media-type parameters. Send the CSV in UTF-8. The CSV supports up to 100,000 recip
 - [GET /v2/EviMail/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchrecipientsquery.md): Lists the recipients of a batch, with cursor pagination. **This endpoint uses the HTTP `QUERY` method, not GET.** OpenAPI cannot express the `QUERY` method, so it is shown here as a `GET` with the fil
 - [DELETE /v2/EviMail/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchrecipientsdelete.md): Removes all recipients from the batch.
 - [POST /v2/EviMail/Batches/{BatchId}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentspost.md): Adds a single attachment to the batch by uploading it as `multipart/form-data`. The attachment is included in emails generated from the batch. Upload exactly one nonempty file and set its filename and
 - [GET /v2/EviMail/Batches/{BatchId}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentsget.md): Returns metadata for all attachments configured on the batch.
 - [DELETE /v2/EviMail/Batches/{BatchId}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentsdelete.md): Removes all attachments from the batch.
 - [GET /v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentget.md): Downloads the binary content of a single batch attachment. The response uses the stored attachment media type.
 - [DELETE /v2/EviMail/Batches/{BatchId}/Attachments/{AttachmentId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchattachmentdelete.md): Removes a single attachment from the batch.
## EviSMS

 - [POST /v1/EviSms/Submit](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismssubmit.md)
 - [GET /v1/EviSms/Query](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsqueryget.md)
 - [POST /v2/EviSms/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchcreate.md): Creates a new, empty SMS batch. Only a `Description` is required at creation; the message text, recipients, and options are set with the subsequent batch endpoints. Returns the `BatchId` used by all o
 - [GET /v2/EviSms/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchesquery.md): Lists SMS batches owned by the caller (or the caller's site), with cursor pagination. **This endpoint uses the HTTP `QUERY` method, not GET.** OpenAPI cannot express the `QUERY` method, so it is shown
 - [GET /v2/EviSms/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchget.md): Retrieves the full state of a batch, including its configured message template and processing progress.
 - [PATCH /v2/EviSms/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchpatch.md): Updates supplied batch metadata and message template options, including the SMS `Text`. Blank values for text fields are ignored. To submit a Draft or Invalid batch, set `State` to `Submitted` and sen
 - [DELETE /v2/EviSms/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchdelete.md): Removes a previously created batch.
 - [POST /v2/EviSms/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientspost.md): Uploads the batch recipient list as a `text/csv` file, replacing any previous list. The upload supports up to 100,000 recipients. Use `;` as the column separator. Mandatory columns: `phonenumber`, `le
 - [GET /v2/EviSms/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientsquery.md): Lists the recipients of a batch, with cursor pagination. **This endpoint uses the HTTP `QUERY` method, not GET.** OpenAPI cannot express the `QUERY` method, so it is shown here as a `GET` with the fil
 - [DELETE /v2/EviSms/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientsdelete.md): Removes all recipients from the batch.
## EviSign

 - [POST /v1/evisign/submit](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignsubmit.md): Creates a new EviSign for the authenticated site/user context.
 - [GET /v1/evisign/query](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignquery.md): Query EviSigns visible to the authenticated context. For metadata-only pages of up to 25, explicitly set IncludeAttachmentBlobsOnResult and IncludeAffidavitBlobsOnResult to false and enable the entry
 - [POST /v1/evisign/cancel](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisigncancel.md): Requests cancellation of a previously submitted EviSign for the authenticated site/user context. Cancellation is accepted and processed asynchronously.
 - [POST /v1/evisign/resend](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignresend.md): Requests resending the signature request for a signing party of a previously submitted EviSign in the authenticated site/user context.
 - [POST /v1/evisign/affidavitrequest](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignaffidavitrequest.md): Asynchronously request an affidavit for an EviSign owned by the caller. The original submission must enable OnDemand affidavits; Draft and Closed entries, exhausted limits and unavailable records are
 - [GET /v2/evisign/{Id}/bundle](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignbundle.md): Download a ZIP containing the original document plus the available files selected by the inclusion flags. The EviSign must belong to the authenticated site; missing or inaccessible entries return 404.
 - [POST /EviSign/SignLink](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisign/evisignsignlink.md): Generate a one-hour link for one party to access one or more already processed EviSigns owned by the caller. Single-item methods: MobilePin, EmailPin, Handwriting, WebClick. Multiple-item flow accepts
## EviPost

 - [POST /v1/EviPost/Submit](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostsubmit.md): Submit a Base64-encoded PDF smaller than 2,097,152 bytes before encoding. Acceptance does not confirm later PDF validation or postal delivery. A processing failure or postal-service rejection can clos
 - [GET /v1/EviPost/Query](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostqueryget.md)
 - [POST /v1/EviPost/AffidavitRequest](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostaffidavitrequest.md): The original submitting account can request an affidavit for a submitted `Letter` or `LetterLite` before it closes. At Submit, enable `AffidavitsOnDemandEnabled` and use `AdvancedContentOnSubmit`, `Ad
 - [POST /v1/EviPost/Cancel](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostcancel.md): Requests cancellation of a previously submitted EviPost. Use this operation for `Letter` with a delivery receipt, delivery attempts, or disposal enabled. The communication must not be `Draft` or `Clos
## Shared Downloads

 - [POST /AttachmentDownload](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/attachmentdownloadpost.md)
 - [GET /AttachmentDownload](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/attachmentdownloadget.md)
 - [POST /AffidavitsDownload](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/affidavitsdownloadpost.md): Packages the requested affidavit PDFs in a ZIP archive. All requested affidavits must exist and be owned by the authenticated user.
 - [GET /AffidavitsDownload](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/affidavitsdownloadget.md): Packages the requested affidavit PDFs in a ZIP archive. Repeat the UniqueIds query parameter for multiple IDs.
 - [HEAD /AffidavitsDownload](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/affidavitsdownloadhead.md): Accepts the same affidavit identifiers as GET and returns the response headers without transferring the archive body.
