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 hour to 60 days). When omitted, the platform's configured TTL default applies, independently of the site or user WebUI send-form default.
Files to include in the hosted notice. This Submit endpoint accepts at most 14 attachments. Each decoded file must be smaller than 8 MiB (8,388,608 bytes); the combined decoded file size must be at most 25 MiB (26,214,400 bytes). The complete base64-encoded JSON request must also fit the API host request-size limit; a request approaching the decoded-file limit can be rejected before attachment validation.
The legal framework and geographic variant for certification. Supported values include Standard, Advanced, QERDS, and their regional variants. Availability depends on the account.
Allow a recipient without a matching verified identity to enroll before accessing the notice content. Omitting this field does not enable enrollment. When true, a site-configured QERDSEnrollmentProfile is required. Qualified recipient identification remains required when enrollment is disabled.
The site-configured QeRDS enrollment profile. Required when QERDSEnrollmentAllowed is true. Any supplied non-empty profile must match a profile configured on the site, including when enrollment is disabled. This is distinct from QERDSIdentityTenant.
Require recipient legal-ID verification before accessing the notice. Must be true for qualified EviNotice certification levels.
Legal-document kind recognized by the service and suitable for the configured identity flow. Supply together with RecipientLegalIdValue; both are required for QERDS_IT and the pair must validate. For QERDS_ES, supply both or omit both. Accepted kinds depend on the target service version and identity configuration; example codes are not an exhaustive list.
A pre-filled legal ID value for the recipient, up to 50 characters. Send it together with RecipientLegalIdKind. Required with RecipientLegalIdKind for QERDS_IT and must be valid for the selected kind.
Selects affidavit kinds to generate when the corresponding events occur. Failure before processing completes closes the notice without generating affidavits. Later transmission or delivery failures can be certified by TransmissionResult or DeliveryResult when requested. Failed is accepted by the request contract but does not generate a separate Failed affidavit. For qualified notices, include both SubmittedAdvanced and Read, or include CompleteAdvanced. Other kinds may be added; Submitted alone does not satisfy the qualified requirement.
Controls how recipients access the evidence record once the recipient has accepted or rejected the notice, or it has closed. Public allows anyone with the link; Challenge asks your question, and AutoChallenge asks for the recipient address. DeliverySignMethod separately protects first access. Supported values: Public, Challenge, AutoChallenge. Unlike EviMail and EviSMS, Default is not supported for EviNotice. For qualified notices, set Public explicitly; the configured global default used when this field is omitted may not satisfy that rule. This evidence-access setting does not replace qualified recipient identification.
The challenge question shown to the visitor. Required only with EvidenceAccessControlMethod Challenge; rejected with other methods.
The expected answer to EvidenceAccessControlChallenge. Required only with EvidenceAccessControlMethod Challenge; rejected with other methods.
Email recipients accept only Email. Mobile recipients can list up to three of SMS, WhatsApp and RCS without repeats; channels are tried in order, moving to the next only after failure. WhatsApp requires service and site enablement; RCS requires site enablement.
Controls how the recipient authenticates to access the hosted notice.
The challenge question shown to the recipient when DeliverySignMethod is Challenge.
The fixed mobile number used to send the PIN when DeliverySignMethod is MobilePin.
The fixed email address used to send the PIN when DeliverySignMethod is EmailPin.
Ordered list of three PIN channel groups. Each element lists the channels offered for one PIN send; channels are not used in parallel. Only valid with DeliverySignMethod MobilePin. After null or empty groups are discarded, supply exactly three non-empty groups without repeated channels within a group. Supported channels: SMS, WhatsApp, RCS. WhatsApp requires service and site enablement; RCS requires site enablement. With an explicit MobilePin method and this field omitted, the default is three SMS attempt groups. NotificationChannels separately routes the notice alert.
[ [ "SMS" ], [ "SMS" ], [ "SMS" ] ]
Controls whether the recipient can accept or reject the notice. EviMail exposes the same behaviour through a field named CommitmentOptions.
Allow the recipient to add a free-text comment when committing. For qualified notices, keep disabled with CommitmentChoice Accept or AcceptOrReject. Use CommitmentChoice Reject when collecting recipient comments or rejection reasons.
Predefined rejection reasons the recipient can select from. Requires CommitmentCommentsAllowed true and cannot be used with CommitmentChoice Accept. Up to 20 reasons, each at most 150 characters, without HTML. Otherwise Submit returns 400.
Require the recipient to select or enter a rejection reason before rejecting. When true, requires CommitmentCommentsAllowed true and cannot be used with CommitmentChoice Accept; otherwise Submit returns 400.
Predefined acceptance reasons the recipient can select from. Requires CommitmentCommentsAllowed true and cannot be used with CommitmentChoice Reject. Up to 20 reasons, each at most 150 characters, without HTML. Otherwise Submit returns 400. Do not configure for qualified acceptance, where recipient comments and acceptance reasons are unavailable.
Require the recipient to select or enter an acceptance reason before accepting. When true, requires CommitmentCommentsAllowed true and cannot be used with CommitmentChoice Reject; otherwise Submit returns 400. Keep false or omitted for qualified acceptance, where acceptance reasons are unavailable.
Supply PushNotificationUrl and PushNotificationFilter together; PushNotificationExtraData is allowed only with both (up to 1,024 characters). Otherwise Submit returns 400. 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.
The URL that receives push notification callbacks when a state in PushNotificationFilter is reached. Supply PushNotificationUrl and PushNotificationFilter together; PushNotificationExtraData is allowed only with both (up to 1,024 characters). Otherwise Submit returns 400. HTTP and HTTPS are accepted; use HTTPS because HTTP omits Comments on Replied and XmissionDetails on Sent.
Arbitrary string passed back verbatim in each push notification payload. Supply PushNotificationUrl and PushNotificationFilter together; PushNotificationExtraData is allowed only with both (up to 1,024 characters). Otherwise Submit returns 400.
BCP 47 language tag controlling the language of the hosted notice UI (e.g. en, es, it). Defaults to en when omitted; does not inherit the site language configured for the WebUI.
BCP 47 language tag controlling the language of generated affidavit documents. Defaults to en when omitted; does not inherit the site language configured for the WebUI.
Visual layout of the hosted notice page. EviMail exposes the same concept through a field named DeliveryAppearance.
Additional text shown on the landing page before the recipient opens the content. Maximum 8,192 characters.
Identifier of an enabled EviNotice:Email:Notification template for email recipients, or of an enabled EviNotice:Sms:Notification template for mobile recipients whose NotificationChannels include SMS. Not used for RCS/WhatsApp-only notifications. 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.
Optional identity context used for recipient identity lookup and in-notice enrollment. When supplied, it must exactly match a tenant configured on the site for the selected certification variant. The context is also recorded with QeRDS service-terms acceptance. Obtain the value during provisioning; this is distinct from QERDSEnrollmentProfile.
An arbitrary cost-centre label recorded with the transaction for internal billing allocation.
When true, the platform keeps tracking recipient attachment downloads until 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: 1 to 20 years; with by-submission billing your voucher tier can impose a lower maximum.
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.
Reminders re-send the notification email while the notice remains open. Only email RecipientAddress values are supported; a mobile recipient returns 400. Reading or deciding stops reminders only when it closes the notice; with a pending commitment choice or EnforceTrackingUntilTimeToLive the notice stays open and reminders continue.
- Productionhttps://api.evicertia.com/v2/EviNotice/Submit
- Pre-production / QAhttps://api.ecertia.com/v2/EviNotice/Submit
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"
}'{ "Id": "550e8400-e29b-41d4-a716-446655440000" }