Skip to content
Development and Integrati...
/API reference/
/
Add batch recipients (CSV...

Namirial Notify APIs (1.0)

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.

Download OpenAPI description
namirialnotify-api.json
namirialnotify-api.yaml
Languages
Servers
Production
https://api.evicertia.com
Pre-production / QA
https://api.ecertia.com

EviNotice

Certified hosted notices with hosted content, attachments, affidavits, and batch delivery via v2.

Operations

Set the batch body

Request

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.

Security
basicAuth
Path
BatchIdstring(uuid)required
Bodytext/htmlrequired
string
curl -i -X PUT \
  -u <username>:<password> \
  'https://api.evicertia.com/v2/EviNotice/Batches/{BatchId}/Body' \
  -H 'Content-Type: text/html' \
  -d '<p>We inform you that today is a very interesting day.</p>'

Responses

Body accepted and queued for update. Poll GET .../{BatchId} to check status.

Add batch recipients (CSV)

Request

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).

Security
basicAuth
Path
BatchIdstring(uuid)required
Bodytext/csvrequired
string
curl -i -X POST \
  -u <username>:<password> \
  'https://api.evicertia.com/v2/EviNotice/Batches/{BatchId}/Recipients' \
  -H 'Content-Type: text/csv' \
  -d 'address;legalname;displayname;*orderid
  jane@example.com;Acme Corp;Jane Doe;ORD-001
  john@example.com;Beta Ltd;John Roe;ORD-002
  '

Responses

Recipients accepted. No response body is returned.

Query batch recipients (HTTP QUERY method)

Request

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.

Security
basicAuth
Path
BatchIdstring(uuid)required
Query
Cursorstring

Opaque pagination cursor returned by the previous response.

Limitinteger[ 1 .. 1000 ]

Maximum number of recipients to return (1–1000).

SortDirectionstring
Enum"None""Ascending""Descending"
curl -i -X GET \
  -u <username>:<password> \
  'https://api.evicertia.com/v2/EviNotice/Batches/{BatchId}/Recipients?Cursor=string&Limit=1&SortDirection=None'

Responses

Query executed successfully.

Bodyapplication/json
Cursorstring

Opaque cursor for the next page of recipients.

ResultsArray of objects(EviNoticeBatchRecipient)
Response
application/json
{
  "Cursor": "string",
  "Results": [
    { … }
  ]
}

EviMail

Certified email submission, status tracking, and on-demand affidavits via v1, plus batch delivery, recipients, and attachments via v2.

Operations

EviSMS

Certified SMS and RCS submission, status tracking, and evidence retrieval via v1, plus SMS batch delivery and recipients via v2.

Operations

EviPost

Certified physical postal delivery with status tracking and on-demand affidavits.

Operations

Shared Downloads

Shared affidavit and attachment download endpoints.

Operations