Skip to content
Development and Integrati...
/API reference/
/
Download all attachments...

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

Query multiple EviNotices

Request

Security
basicAuth
Bodyapplication/json
Limitinteger[ 1 .. 100 ]

Maximum number of results to return per page.

Default 100
Ownerstring(email)

Filter by the email address of the account that submitted the notices.

LookupKeysArray of strings

Filter by one or more integrator-assigned lookup keys.

LinkedIdstring(uuid)

Filter by linked ID.

Statestring

Filter by current notice state.

Enum"Draft""Submitted""Processed""Sent""Dispatched""Delivered""Received""Read""Replied""Closed"
Outcomestring

Filter by certification outcome.

Enum"None""Certified""Sent""Delivered""Received""Read""Accepted""Rejected""Failed""Cancelled"
Cursorstring

Opaque pagination cursor returned in the previous response. Pass this value to retrieve the next page.

curl -i -X POST \
  -u <username>:<password> \
  https://api.evicertia.com/v2/EviNotice/Query \
  -H 'Content-Type: application/json' \
  -d '{
    "Limit": 100,
    "Owner": "user@example.com",
    "LookupKeys": [
      "string"
    ],
    "LinkedId": "5b64f22c-bd29-4d24-affe-e0bd94d5c0e9",
    "State": "Draft",
    "Outcome": "None",
    "Cursor": "string"
  }'

Responses

Query executed successfully

Bodyapplication/json
Cursorstring

Opaque cursor for the next page of results. Pass this value as Cursor in a subsequent request to retrieve the next page. Absent when there are no further results.

ResultsArray of objects(EviNoticeSummary)

The list of EviNotice summaries matching the query.

Response
application/json
{
  "Cursor": "AQAAAADFDwwAAAAAABVOhADim0HUo3Jm+wAAAAAAAAA=",
  "Results": [
    { … }
  ]
}

Download all attachments of an EviNotice

Request

Security
basicAuth
Path
Idstring(uuid)required

The UUID of the EviNotice.

curl -i -X GET \
  -u <username>:<password> \
  'https://api.evicertia.com/v2/EviNotice/{Id}/Attachments'

Responses

ZIP file containing all attachments.

Bodyapplication/zip
string(binary)

Download all affidavits of an EviNotice

Request

Security
basicAuth
Path
Idstring(uuid)required

The UUID of the EviNotice.

curl -i -X GET \
  -u <username>:<password> \
  'https://api.evicertia.com/v2/EviNotice/{Id}/Affidavits'

Responses

ZIP file containing all affidavits.

Bodyapplication/zip
string(binary)

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