Skip to content

API reference overview

Namirial Notify provides REST APIs for sending certified communications and retrieving related evidence. Service APIs let you submit messages or notices, query their status, and receive real-time callbacks when their state changes.

Available APIs

APIServiceUse caseVersion
EviMail APICertified emailSend individual emails or batches with proof of delivery and read receiptsv1 (single-message), v2 (batch)
EviNotice APIHosted noticesSend individual notices or batches with hosted content, digital signatures, and commitment trackingv2
EviSMS APISMS & RCSSend certified SMS messages or SMS batches; single-message submissions also support RCSv1 (single-message), v2 (batch)
EviSign APIElectronic signature (LTS)Submit and track signature requests, retrieve evidence bundles, and generate signing linksv1 (issuer operations), v2 (Bundle); separate SignLink endpoint
EviPost APIPhysical postalSend certified physical postal communications (burofax equivalent) with delivery trackingv1
Shared download APIsAffidavits and attachmentsDownload affidavit PDFs or attachment content when you already have their IDsv1

Each reference page includes:

  • Complete endpoint descriptions with request/response examples
  • Key request and response fields
  • State and outcome tables
  • Links to the full OpenAPI 3.0.3 specification

Use the unified Namirial Notify OpenAPI page to browse all documented service endpoints in one place.

EviMail, EviNotice, and EviSMS each include their single-message and batch operations under one service entry. For batch workflows and options, see the batch sections in the EviMail reference, EviNotice reference, and EviSMS reference.

Common patterns

Service APIs share these fundamental patterns:

  • Submit — POST a message with metadata, recipients, options, and optional attachments. Returns a unique ID.
  • Query — GET or POST to retrieve the status of one or many submitted messages, filtered by ID, state, outcome, or lookup key.
  • Callbacks — Configure PushNotificationUrl and PushNotificationFilter to receive real-time webhooks when messages change state.
  • States & outcomes — Submitted messages move through a service-specific lifecycle, with Closed as the terminal state. Intermediate milestones such as Sent or Delivered appear only when the corresponding event is recorded; at closure, Outcome reports the final result.
  • Affidavits — Request signed evidence PDFs for key events. Callbacks and metadata-only query modes expose affidavit identifiers; download endpoints return the PDF files. Deprecated v1 query options can still embed PDF bytes for one result, but are not recommended for new integrations.

Getting started

Authentication

All APIs require HTTP Basic authentication. Include your Namirial Notify credentials (username and password) in the Authorization header:

Authorization: Basic <base64(username:password)>

Qualified EviNotice submission also requires a specifically issued client certificate in addition to these credentials. See Integrate QeRDS notices.

Contact your Namirial Notify account manager if you don't have credentials yet. API access is provisioned per service. If valid credentials return 403 Forbidden, contact your account manager to confirm that the required service permission is enabled.

Environments

Test in pre-production before switching to production:

EnvironmentBase URLUse
Productionhttps://api.evicertia.comLive certified communications
Pre-production / QAhttps://api.ecertia.comTesting and integration

For 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. Use public routes such as /v1/EviMail/Submit, /v1/EviSms/Submit, and /v1/EviPost/Submit. Shared download source contracts expose root routes such as /AffidavitsDownload and /AttachmentDownload; use the route style shown in the relevant reference page for that API. EviSign issuer operations use /v1/evisign/...; Bundle uses /v2/evisign/{Id}/bundle. SignLink uses the application host (app.evicertia.com or app.ecertia.com) and /EviSign/SignLink, without a version prefix. EviNotice uses the /v2/ path prefix. The legacy /api/v2/... form is still accepted for backward compatibility. Some lower-level technical artifacts may show V1 routes without the /v1 prefix. For customer integrations, use the public paths shown in this documentation.

Request and response format

All APIs accept JSON for requests and return JSON for most responses. The exceptions include affidavit download endpoints, which return PDF files or ZIP packages, and EviNotice attachment downloads, which return binary files or ZIP packages, and EviSign Bundle, which returns a ZIP file. Timestamps are ISO 8601 format. Large payloads (query results) may be paginated using Limit and Offset (EviMail, EviSMS, EviSign, EviPost) or cursors (EviNotice).

Online retention and LTA storage

OnlineRetentionPeriod and LtaStorage control separate parts of evidence custody. OnlineRetentionPeriod specifies how many years the evidence remains accessible through Namirial Notify. When LtaStorage is true, the platform stores the transaction bundle in Namirial Archive during post-close processing, after the individual transaction reaches Closed; it does not wait for the online retention period to expire. The site must have LTA enabled.

For batch APIs, the LTA option is propagated to each transaction generated from the batch. Each generated transaction is stored after its own tracking closes; the batch itself has no separate LTA lifecycle.

The documented callback filters do not include an LTA-completion event. Do not treat a Closed callback as proof that the post-close LTA step finished. In the transaction history, Namirial LTA Stored confirms successful storage. See Archiving and retention for the full lifecycle.

Next steps