Skip to content

Get a single EviNotice

Request

Security
basicAuth
Path
Idstring, (uuid)required

The UUID of the EviNotice returned at submission.

Query
IncludeAffidavitsboolean

Include affidavit metadata in the response.

IncludeAttachmentsboolean

Include attachment metadata in the response.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.evicertia.com/v2/EviNotice/{Id}?IncludeAffidavits=true&IncludeAttachments=true'

Responses

EviNotice retrieved

Bodyapplication/json
Idstring, (uuid)

Unique identifier of the EviNotice.

LinkedIdstring

ID of a related EviNotice, if applicable.

Subjectstring

Subject of the certified notice.

LookupKeystring

The integrator-assigned lookup key.

Issuerstring

Legal name of the issuing organisation.

IssuerEmailstring

Email address of the issuer account.

IssuerPhonestring

Phone number of the issuer account, if set.

RecipientAddressstring

Email address or mobile number of the recipient.

RecipientDisplayNamestring

Display name of the recipient.

RecipientLegalNamestring

Legal name of the recipient.

Statestring

Current step in the notice lifecycle. Closed is the only terminal state.

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

None while open. At Closed, the first recorded milestone in this order determines the final outcome: Failed, Rejected, Accepted, Refused, Read, Received, Delivered, Sent, Certified. Received records access to the hosted notice link. Read records opening the hosted content. Cancelled is a compatibility value in the response enum and is not produced by current closure logic.

Enum:"None""Certified""Sent""Delivered""Received""Read""Accepted""Rejected""Failed""Cancelled"
CreationDatestring, (date-time)
LastUpdateDatestring, (date-time)
SubmittedOnstring, (date-time)

Timestamp when the submission was accepted by the platform.

ProcessedOnstring, (date-time)

Timestamp recorded for the Processed milestone. It is populated after initial processing and content certification succeed, but its value is the admission time recorded at submission, so it normally equals SubmittedOn and does not measure processing duration.

SentOnstring, (date-time)

Event time reported by the successful notification sending result. For email, this is transmission to the recipient's mail system; for mobile channels, successful transmission reported by the sending channel. This does not certify that the hosted notice was read. Do not infer callback arrival order or require strict numerical timestamp ordering from the logical lifecycle sequence.

DispatchedOnstring, (date-time)

Timestamp when the platform, after its initial checks, accepted responsibility for the communication and issued the notification send request to its sending process. It does not confirm successful transmission to the remote system. Dispatch logically precedes the sending result; equal or strictly ordered timestamp values and callback arrival order are not guaranteed.

DeliveredOnstring, (date-time)

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.

ReadOnstring, (date-time)

Timestamp when the recipient accessed the protected content on the platform.

RepliedOnstring, (date-time)
ExpiredOnstring, (date-time)

Time the notice closed, whatever the reason (including expiry, decision, refusal or failure); not only TimeToLive expiry.

AcceptedOnstring, (date-time)
RejectedOnstring, (date-time)
FailedOnstring, (date-time)
RefusedOnstring, (date-time)
ArchivedOnstring, (date-time)
TimeToLiveinteger

The TimeToLive value (in minutes) that was set at submission.

AllowRefusalboolean

Whether the recipient was allowed to refuse the notice without opening it.

NotaryProfilestring

The notary certification profile applied.

SourceChannelstring

The channel through which the notice was submitted (e.g. API, portal).

OnlineRetentionPeriodinteger

Number of years the notice and its evidence remain accessible online.

NotaryRetentionboolean

Whether the evidence is retained by a notary for long-term legal storage.

ReceivedOnstring, (date-time)

Timestamp when the recipient opened the access link and reached the delivery page on the platform.

Fromstring

From address used in the delivery notification email.

CostCentrestring

Cost-centre label recorded with the transaction for internal billing allocation.

CommitmentCommentsstring

Free-text comment provided by the recipient when accepting or rejecting the notice.

AffidavitKindsArray of strings

The affidavit event types configured at submission.

Remindersobject(EviNoticeReminders)

Reminder configuration as set at submission. Absent when no reminders were configured.

NotificationChannelsArray of strings

Channels used to deliver the notification to the recipient.

Items Enum:"SMS""WhatsApp""RCS""Email"
MobilePinChannelsArray of items

PIN channel groups configured at submission. Each element lists channels offered for one PIN send, not parallel sends. The first PIN, sent when the recipient requests it, uses the first channel of the first group; no channel choice is offered. On a resend, the recipient chooses one channel from the next group (no choice is shown when that group has a single channel); after the third send, the last group is reused.

SiteNamestring

Name of the Namirial Notify site under which this notice was submitted.

XmissionResultboolean or null

Whether the delivery notification email or SMS was successfully transmitted.

XmissionSummarystring

Human-readable summary of the transmission result (e.g. bounce or SMTP reply code).

CustomLayoutLogoUrlstring, (uri)

Custom logo URL that was configured at submission.

AffidavitsArray of objects(EviNoticeAffidavitInfo)

Metadata for each generated affidavit. Present when IncludeAffidavits is true.

AttachmentsArray of objects(EviNoticeAttachmentInfo)

Metadata for each attachment. Present when IncludeAttachments is true.

Response
{ "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:01Z", "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" }