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.
| API | Service | Use case | Version |
|---|---|---|---|
| EviMail API | Certified email | Send legally binding emails with proof of delivery and read receipts | v1 |
| EviNotice API | Hosted notices | Send notices with hosted content, digital signatures, and commitment tracking | v2 |
| EviSMS API | SMS & RCS | Send certified SMS messages with optional RCS enhancements | v1 |
| EviPost API | Physical postal | Send certified physical postal communications (burofax equivalent) with delivery tracking | v1 |
| Shared download APIs | Attachments | Download attachments directly when you already have their IDs | v1 |
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.
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
PushNotificationUrlandPushNotificationFilterto receive real-time webhooks when messages change state. - States & outcomes — Submitted messages move through a service-specific lifecycle, with
Closedas the terminal state. Intermediate milestones such asSentorDeliveredappear only when the corresponding event is recorded; at closure,Outcomereports the final result. - Affidavits — Request evidence records (affidavits) to be generated for key events. Retrieve them from query results or dedicated download endpoints, depending on the service.
All APIs require HTTP Basic authentication. Include your Namirial Notify credentials (username and password) in the Authorization header:
Authorization: Basic <base64(username:password)>Contact your Namirial Notify account manager if you don't have credentials yet.
Test in pre-production before switching to production:
| Environment | Base URL | Use |
|---|---|---|
| Production | https://api.evicertia.com | Live certified communications |
| Pre-production / QA | https://api.ecertia.com | Testing and integration |
For the public Namirial Notify API environments, EviMail, EviSMS, and EviPost are exposed under the /v1 base path. Use public routes such as /v1/EviMail/Submit, /v1/EviSms/Submit, and /v1/EviPost/Submit. Shared download source contracts expose routes such as /AttachmentDownload; use the route style shown in the relevant reference page for that API. 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.
All APIs accept JSON for requests and return JSON for most responses. The exceptions are download endpoints, such as EviNotice attachment and affidavit downloads, which return binary files or ZIP packages. Timestamps are ISO 8601 format. Large payloads (query results) may be paginated using Limit and Offset (EviMail, EviSMS, EviPost) or cursors (EviNotice).
- Choose your API — Read the use case table above and pick the service that matches your need. Then dive into its reference page.
- Set up integration — See Development and integration guides for API collections, callback setup, and best practices.
- Handle failures consistently — Use the shared Error handling guide.
- Follow end-to-end patterns — Use Integration workflows for submit, track, and evidence retrieval flows.
- Harden your integration — Review Security and authentication.
- Plan for scale — Review Performance and scaling.
- Understand lifecycle — Every message has a state and an outcome. Learn the difference in States and outcomes.
- Get evidence — Understand how to request and use affidavits in Evidence and affidavits.
- Real-time updates — Set up webhooks and read about callback payload structure in Callbacks and webhooks.