# Namirial Notify APIs Unified OpenAPI reference for the Namirial Notify service APIs. This specification aggregates EviNotice, EviMail, EviSMS, 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. 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 Certified hosted notices with hosted content, attachments, affidavits, and batch delivery via v2. ### Submit a new EviNotice - [POST /v2/EviNotice/Submit](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticesubmit.md) ### Get a single EviNotice - [GET /v2/EviNotice/{Id}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeget.md) ### Query multiple EviNotices - [POST /v2/EviNotice/Query](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticequery.md) ### Download all attachments of an EviNotice - [GET /v2/EviNotice/{Id}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeattachmentsdownload.md) ### Download all affidavits of an EviNotice - [GET /v2/EviNotice/{Id}/Affidavits](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitsdownload.md) ### Download one EviNotice affidavit - [GET /v2/EviNotice/Affidavits/{Id}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitdownload.md) ### Request an on-demand affidavit - [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 Draft, not Closed, and within the configured per-notice on-demand limit. ### Create a notice batch - [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 by all other batch operations. ### Query notice batches (HTTP QUERY method) - [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 shown here as a GET with the filter fields as query parameters. In practice, send an HTTP QUERY request with the fields in a JSON body (States, Cursor, Limit, SortBy, SortOrder, Direction, TextSearch). ### Get a notice batch - [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. ### Update a notice batch - [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 schedule it). Setting ScheduledDate schedules the batch for later dispatch. Batch scheduling uses UTC. Specify ScheduledDate in UTC. ### Delete a notice batch - [DELETE /v2/EviNotice/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchdelete.md): Removes a previously created batch. ### Set the batch body - [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. ### Add batch recipients (CSV) - [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, custodychallenge, custodychallengeresponse, deliverychallenge, deliverychallengeresponse, deliveryotpchannel, deliveryotpaddress. Custom per-recipient fields are added as extra columns prefixed with (for example, orderid). ### Query batch recipients (HTTP QUERY method) - [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 filter fields as query parameters. In practice, send an HTTP QUERY request with the fields (Cursor, Limit, SortDirection) in a JSON body. ### Delete all batch recipients - [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. ### Add a batch attachment - [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. ### List batch attachments - [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 all batch attachments - [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. ### Download a batch attachment - [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 a 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 Certified email submission, status tracking, and on-demand affidavits via v1, plus batch delivery, recipients, and attachments via v2. ### Submit a certified email - [POST /v1/EviMail/Submit](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailsubmit.md) ### Query certified emails (GET) - [GET /v1/EviMail/Query](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailqueryget.md) ### Request an on-demand affidavit - [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 on-demand affidavits. ### Create an email batch - [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 by all other batch operations. ### Query email batches (HTTP QUERY method) - [GET /v2/EviMail/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchesquery.md): Lists email 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 here as a GET with the filter fields as query parameters. In practice, send an HTTP QUERY request with the fields in a JSON body (States, Cursor, Limit, SortBy, SortOrder, Direction, TextSearch). ### Get an email batch - [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. ### Update an email batch - [PATCH /v2/EviMail/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchpatch.md): Updates batch metadata and the email template options. All fields are optional; only the fields supplied are changed. Setting State transitions the batch (for example, to start processing). Setting ScheduledDate schedules the batch. Batch scheduling uses UTC. Specify ScheduledDate in UTC. ### Delete an email batch - [DELETE /v2/EviMail/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchdelete.md): Removes a previously created batch. ### Set the batch body - [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. ### Add batch recipients (CSV) - [POST /v2/EviMail/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evimail/evimailbatchrecipientspost.md): Adds recipients to the batch by uploading a text/csv file. The CSV uses ; as the column separator. Mandatory columns: emailaddress, legalname. Optional columns: lookupkey, displayname, evidenceaccesscontrolchallenge, evidenceaccesscontrolchallengeresponse. Custom per-recipient fields are added as extra columns prefixed with (for example, orderid). ### Query batch recipients (HTTP QUERY method) - [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 filter fields as query parameters. In practice, send an HTTP QUERY request with the fields (Cursor, Limit, SortDirection) in a JSON body. ### Delete all batch recipients - [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. ### Add a batch attachment - [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 every email generated from the batch. ### List batch attachments - [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 all batch attachments - [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. ### Download a batch attachment - [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. ### Delete a batch attachment - [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 Certified SMS and RCS submission, status tracking, and evidence retrieval via v1, plus SMS batch delivery and recipients via v2. ### Submit a certified SMS - [POST /v1/EviSms/Submit](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismssubmit.md) ### Query certified SMS messages (GET) - [GET /v1/EviSms/Query](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsqueryget.md) ### Create an SMS batch - [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 other batch operations. ### Query SMS batches (HTTP QUERY method) - [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 here as a GET with the filter fields as query parameters. In practice, send an HTTP QUERY request with the fields in a JSON body (States, Cursor, Limit, SortBy, SortOrder, Direction, TextSearch). ### Get an SMS batch - [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. ### Update an SMS batch - [PATCH /v2/EviSms/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchpatch.md): Updates batch metadata and the message template options, including the SMS Text. All fields are optional; only the fields supplied are changed. Setting State transitions the batch (for example, to start processing). Setting ScheduledDate schedules the batch. Batch scheduling uses UTC. Specify ScheduledDate in UTC. ### Delete an SMS batch - [DELETE /v2/EviSms/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchdelete.md): Removes a previously created batch. ### Add batch recipients (CSV) - [POST /v2/EviSms/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientspost.md): Adds recipients to the batch by uploading a text/csv file. The CSV uses ; as the column separator. Mandatory columns: phonenumber, legalname. Optional columns: lookupkey, evidenceaccesscontrolchallenge, evidenceaccesscontrolchallengeresponse. Custom per-recipient fields are added as extra columns prefixed with (for example, orderid). ### Query batch recipients (HTTP QUERY method) - [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 filter fields as query parameters. In practice, send an HTTP QUERY request with the fields (Cursor, Limit, SortDirection) in a JSON body. ### Delete all batch recipients - [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. ## EviPost Certified physical postal delivery with status tracking and on-demand affidavits. ### Submit a certified postal communication - [POST /v1/EviPost/Submit](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostsubmit.md) ### Query certified postal communications (GET) - [GET /v1/EviPost/Query](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostqueryget.md) ### Request an on-demand affidavit - [POST /v1/EviPost/AffidavitRequest](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostaffidavitrequest.md): Generates a custom affidavit for a previously submitted EviPost. Requires that AffidavitsOnDemandEnabled: true was set in the original Submit request, and that AffidavitProfile was set to AdvancedContentOnSubmit, AdvancedContentOnClose, or AdvancedContentOnSubmitAndOnClose. The affidavit is generated asynchronously. ### Cancel a postal communication - [POST /v1/EviPost/Cancel](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evipost/evipostcancel.md): Cancels a previously submitted EviPost that has not yet been dispatched to the postal carrier. Only the account that submitted the postal communication can cancel it. Requires the CanUseCancel permission in addition to the standard EviPost API permission. ## Shared Downloads Shared affidavit and attachment download endpoints. ### Download attachments by ID - [POST /AttachmentDownload](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/attachmentdownloadpost.md) ### Download attachments by ID using query parameters - [GET /AttachmentDownload](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/shared-downloads/attachmentdownloadget.md) ### Download affidavit PDFs by ID - [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. ### Download affidavit PDFs by ID using query parameters - [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. ### Check an affidavit archive request - [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.