Certified hosted notices with hosted content, attachments, affidavits, and batch delivery via v2.
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
Languages
Servers
Production
https://api.evicertia.com
Pre-production / QA
https://api.ecertia.com
Bodyapplication/jsonrequired
Recipient's email address or mobile phone number in E.164 format. The delivery notification is sent to this address.
The legal name of the sending organisation, recorded in the certification evidence.
An arbitrary key assigned by the integrator to correlate this notice with records in your own system.
The time in minutes during which the platform will attempt delivery and keep the notice accessible to the recipient. Range: 60–86,400 (1 minute to 60 days). When omitted, the account's configured default applies.
Example: 10080
Files to include in the hosted notice. Maximum 15 attachments; maximum 8 MB per attachment; maximum 25 MB total across all attachments.
The legal framework and geographic variant for certification. Supported values include Standard, Advanced, QERDS, and their regional variants. Availability depends on the account.
Enum"Standard""Advanced""QERDS""Standard_CO""Standard_CR""Standard_EC""Standard_EU""Standard_MX""Standard_PE""Advanced_CO"
Example: "Advanced_EU"
Allow the recipient to enrol in a QERDS identity during the commitment flow.
Require the recipient to provide a government-issued legal ID before accessing the notice.
The type of legal ID to request from the recipient.
Enum"IDC:ES""PAS:ES""PAS:IT""TIN:IT"
The set of evidence events for which affidavits should be generated.
Items Enum"Submitted""SubmittedAdvanced""Dispatched""TransmissionResult""DeliveryResult""Received""Read""Committed""CommittedAdvanced""Refused"
Controls how recipients access the evidence record after the notice lifecycle ends. Supported values: Public, Challenge, AutoChallenge. Unlike EviMail and EviSMS, Default is not supported for EviNotice.
Enum"AutoChallenge""Public""Challenge"
The challenge question shown to the recipient when EvidenceAccessControlMethod is Challenge.
The delivery channels used to send the notification to the recipient.
Items Enum"SMS""WhatsApp""RCS""Email"
Controls how the recipient authenticates to access the hosted notice.
Enum"WebClick""Challenge""MobilePin""EmailPin"
The challenge question shown to the recipient when DeliverySignMethod is Challenge.
The fixed mobile number used to send the PIN when DeliverySignMethod is MobilePin.
Example: "+34600000000"
The fixed email address used to send the PIN when DeliverySignMethod is EmailPin.
Ordered list of channel groups for PIN delivery attempts. Each element is an array of channel names tried in parallel for that attempt. Supported channels: Sms, Rcs, WhatsApp.
Example: [["Sms","Rcs","WhatsApp"],["Sms","Rcs","WhatsApp"],["Sms","Rcs","WhatsApp"]]
Controls whether the recipient can accept or reject the notice. EviMail exposes the same behaviour through a field named CommitmentOptions.
Enum"Disabled""Accept""Reject""AcceptOrReject"
Require the recipient to select or enter a rejection reason before rejecting.
Require the recipient to select or enter an acceptance reason before accepting.
State transitions that trigger a push notification callback to PushNotificationUrl. AffidavitPublished is a platform meta-event that fires when affidavit generation completes — it is not a lifecycle state.
Items Enum"Processed""Sent""Dispatched""Delivered""Received""Read""Replied""Failed""Closed""AffidavitPublished"
The URL that receives push notification callbacks when a state in PushNotificationFilter is reached.
Arbitrary string passed back verbatim in each push notification payload.
BCP 47 language tag controlling the language of the hosted notice UI (e.g. en, es, it).
Example: "en"
BCP 47 language tag controlling the language of generated affidavit documents.
Example: "en"
Visual layout of the hosted notice page. EviMail exposes the same concept through a field named DeliveryAppearance.
Enum"Certified""AsIs"
Custom informational text shown to the recipient on the hosted notice landing page.
Identifier of an enabled custom communication template used for the recipient's notification email, replacing the default system template. See Using communication templates from the API.
Key-value pairs supplying values for the user variables declared in NotificationTemplate.
Identifier of an enabled custom template used for the issuer's status notification email. See Using communication templates from the API.
Key-value pairs supplying values for the user variables declared in OwnerNotificationTemplate.
Custom label for the accept/reject commitment button shown to the recipient.
When true, the hosted notice shows only the commitment buttons and hides the free-text input.
An arbitrary cost-centre label recorded with the transaction for internal billing allocation.
When true, the platform keeps tracking content/attachment downloads until the TimeToLive elapses. This must be enabled together with the ContentDownload affidavit kind — enabling one without the other returns a validation error.
When true, the Sender header is removed from the recipient notification email.
When true, internal platform references are suppressed in the generated affidavits.
When true, the evidence for this transaction is stored in Namirial Archive during post-close processing after tracking reaches Closed. Requires LTA to be enabled for the site. OnlineRetentionPeriod separately controls online accessibility.
When true, the recipient can explicitly refuse the notice before reading it (records a Refused outcome).
Online custody period in years during which the evidence remains accessible online before archiving or removal.
When true, the evidence is placed under notarial deposit. Requires NotaryProfile to be set.
The notary profile identifier to use for notarial deposit. Required when NotaryRetention is true.
- Productionhttps://api.evicertia.com/v2/EviNotice/Submit
- Pre-production / QAhttps://api.ecertia.com/v2/EviNotice/Submit
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- Standard certification, email delivery, minimal options
- Advanced certification with MobilePin, commitment, attachments, reminders
curl -i -X POST \
-u <username>:<password> \
https://api.evicertia.com/v2/EviNotice/Submit \
-H 'Content-Type: application/json' \
-H 'X-Evi-IdempotencyToken: string' \
-d '{
"Subject": "Subject of the certified communication",
"Body": "We inform you that today is a very interesting day.<br>Best Regards,",
"LookupKey": "05",
"TimeToLive": 10080,
"RecipientAddress": "recipient@example.com",
"RecipientDisplayName": "Jane Doe",
"RecipientLegalName": "Acme Corp",
"CertificationLevel": "Standard_EU",
"IssuerLegalName": "Sender Co.",
"EvidenceAccessControlMethod": "Public",
"DeliverySignMethod": "WebClick",
"CommitmentChoice": "Disabled",
"Language": "en",
"AffidavitLanguage": "en",
"NotificationLayout": "Certified"
}'Response
application/json
{ "Id": "550e8400-e29b-41d4-a716-446655440000" }
- Productionhttps://api.evicertia.com/v2/EviNotice/{Id}
- Pre-production / QAhttps://api.ecertia.com/v2/EviNotice/{Id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.evicertia.com/v2/EviNotice/{Id}?IncludeAffidavits=true&IncludeAttachments=true'EviNotice retrieved
Current step in the notice lifecycle.
Enum"Draft""Submitted""Processed""Sent""Dispatched""Delivered""Received""Read""Replied""Closed"
Overall result of the certification process. When a notice is refused, the lifecycle completes with state Closed and outcome Refused — Refused does not appear as a lifecycle state. Cancelled may appear on legacy records; its trigger is not part of the standard integration flow.
Enum"None""Certified""Sent""Delivered""Received""Read""Accepted""Rejected""Failed""Cancelled"
Timestamp when transmission of the notification was confirmed — accepted by the recipient's mail system (email) or by the messaging operator (mobile channels). Always equal to or later than DispatchedOn.
Timestamp when the platform completed its checks and accepted responsibility for the communication. The notification is not yet sent, so DispatchedOn precedes SentOn and typically matches ProcessedOn.
Email: timestamp when delivery to the recipient's mail system was confirmed — best-effort, may be absent even when the message was delivered. Mobile channels: operator delivery confirmation.
Timestamp when the recipient opened the access link and reached the delivery page on the platform.
Free-text comment provided by the recipient when accepting or rejecting the notice.
Reminder configuration as set at submission. Absent when no reminders were configured.
Channels used to deliver the notification to the recipient.
Items Enum"SMS""WhatsApp""RCS""Email"
PIN delivery channel groups as configured at submission. Each element is an array of channels tried in parallel for that attempt.
Items Enum"SMS""WhatsApp""RCS"
Whether the delivery notification email or SMS was successfully transmitted.
Human-readable summary of the transmission result (e.g. bounce or SMTP reply code).
Metadata for each generated affidavit. Present when IncludeAffidavits is true.
Response
application/json
{ "Id": "550e8400-e29b-41d4-a716-446655440000", "Subject": "Contract review required", "LookupKey": "CONTRACT-001", "Issuer": "Sender Co.", "IssuerEmail": "sender@example.com", "RecipientAddress": "recipient@example.com", "RecipientDisplayName": "Jane Doe", "RecipientLegalName": "Acme Corp", "State": "Read", "Outcome": "None", "CreationDate": "2026-01-15T09:00:00Z", "LastUpdateDate": "2026-01-16T11:23:00Z", "SubmittedOn": "2026-01-15T09:00:01Z", "ProcessedOn": "2026-01-15T09:00:03Z", "SentOn": "2026-01-15T09:00:10Z", "DispatchedOn": "2026-01-15T09:00:03Z", "DeliveredOn": "2026-01-15T09:15:00Z", "ReceivedOn": "2026-01-16T11:20:00Z", "ReadOn": "2026-01-16T11:23:00Z", "TimeToLive": 10080, "AllowRefusal": false, "NotaryRetention": false, "OnlineRetentionPeriod": 1, "SourceChannel": "Api", "AffidavitKinds": [ "TransmissionResult", "DeliveryResult", "Read" ], "SiteName": "acme-corp", "XmissionResult": true, "XmissionSummary": "250 OK" }
Bodyapplication/json
Filter by current notice state.
Enum"Draft""Submitted""Processed""Sent""Dispatched""Delivered""Received""Read""Replied""Closed"
Filter by certification outcome.
Enum"None""Certified""Sent""Delivered""Received""Read""Accepted""Rejected""Failed""Cancelled"
- Productionhttps://api.evicertia.com/v2/EviNotice/Query
- Pre-production / QAhttps://api.ecertia.com/v2/EviNotice/Query
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
}'Response
application/json
{ "Cursor": "AQAAAADFDwwAAAAAABVOhADim0HUo3Jm+wAAAAAAAAA=", "Results": [ { … } ] }