Vai al contenuto

Submit a new EviNotice

Richiesta

Sicurezza
basicAuth
Intestazioni
X-Evi-IdempotencyTokenstring

Optional idempotency token (UUID recommended) to prevent duplicate submissions on retry. A replay of a cached 200 OK submission returns 202 Accepted. Responses 400, 401, 408, 409, 429, and 5xx are not cached for replay.

Corpoapplication/jsonobbligatorio
Subjectstringobbligatorio

The subject line of the certified notice.

Bodystringobbligatorio

The HTML or plain-text body of the hosted notice.

RecipientAddressstringobbligatorio

Recipient's email address or mobile phone number in E.164 format. The delivery notification is sent to this address.

RecipientDisplayNamestring

The display name shown to the recipient in the delivery notification.

RecipientLegalNamestring

The legal name of the recipient, recorded in the certification evidence.

IssuerLegalNamestring

The legal name of the sending organisation, recorded in the certification evidence.

Fromstring

Override the sender address shown in the delivery notification email.

ReplyTostring

Reply-to address for the delivery notification email.

LookupKeystring

An arbitrary key assigned by the integrator to correlate this notice with records in your own system.

CustomLayoutLogoUrlstring, (uri)

URL of a custom logo to display in the hosted notice layout.

TimeToLiveinteger, [ 60 .. 86400 ]

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.

Esempio:10080
AttachmentsArray of objects, <= 14 items(EviNoticeAttachment)

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.

CertificationLevelstring

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"
Esempio:"Advanced_EU"
QERDSEnrollmentAllowedboolean

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.

QERDSEnrollmentProfilestring

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.

RecipientLegalIdRequiredboolean

Require recipient legal-ID verification before accessing the notice. Must be true for qualified EviNotice certification levels.

RecipientLegalIdKindstring

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.

Esempio:"TIN:IT"
RecipientLegalIdValuestring

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.

AffidavitKindsArray of strings

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.

Items Enum:"Submitted""SubmittedAdvanced""Dispatched""TransmissionResult""DeliveryResult""Received""Read""Committed""CommittedAdvanced""Refused"
EvidenceAccessControlMethodstring

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.

Enum:"AutoChallenge""Public""Challenge"
EvidenceAccessControlChallengestring

The challenge question shown to the visitor. Required only with EvidenceAccessControlMethod Challenge; rejected with other methods.

EvidenceAccessControlChallengeResponsestring

The expected answer to EvidenceAccessControlChallenge. Required only with EvidenceAccessControlMethod Challenge; rejected with other methods.

NotificationChannelsArray of strings

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.

Items Enum:"SMS""WhatsApp""RCS""Email"
DeliverySignMethodstring

Controls how the recipient authenticates to access the hosted notice.

Enum:"WebClick""Challenge""MobilePin""EmailPin"
DeliverySignChallengestring

The challenge question shown to the recipient when DeliverySignMethod is Challenge.

DeliverySignChallengeResponsestring

The expected answer to the challenge question.

DeliverySignFixedMobilestring

The fixed mobile number used to send the PIN when DeliverySignMethod is MobilePin.

Esempio:"+34600000000"
DeliverySignFixedEmailstring

The fixed email address used to send the PIN when DeliverySignMethod is EmailPin.

MobilePinChannelsArray of items

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.

Esempio:
[ [ "SMS" ], [ "SMS" ], [ "SMS" ] ]
CommitmentChoicestring

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"
CommitmentCommentsAllowedboolean

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.

RejectReasonsArray of strings

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.

RequireRejectReasonboolean

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.

AcceptReasonsArray of strings

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.

RequireAcceptReasonboolean

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.

PushNotificationFilterArray of strings

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.

Items Enum:"Processed""Sent""Dispatched""Delivered""Received""Read""Replied""Failed""Closed""AffidavitPublished"
PushNotificationUrlstring, (uri)

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.

PushNotificationExtraDatastring

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.

Languagestring

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.

Predefinito:"en"
Enum:"ca""de""el""en""es""fr""it""pt""pt-BR""ro"
Esempio:"en"
AffidavitLanguagestring

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.

Predefinito:"en"
Enum:"ca""de""el""en""es""fr""it""pt""pt-BR""ro"
Esempio:"en"
NotificationLayoutstring

Visual layout of the hosted notice page. EviMail exposes the same concept through a field named DeliveryAppearance.

Enum:"Certified""AsIs"
LandingPageInfoTextstring

Additional text shown on the landing page before the recipient opens the content. Maximum 8,192 characters.

NotificationTemplatestring

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.

NotificationTemplateValuesobject

Key-value pairs supplying values for the user variables declared in NotificationTemplate.

OwnerNotificationTemplatestring

Identifier of an enabled custom template used for the issuer's status notification email. See Using communication templates from the API.

OwnerNotificationTemplateValuesobject

Key-value pairs supplying values for the user variables declared in OwnerNotificationTemplate.

CommitmentChoiceButtonTextstring

Custom action-button label. Up to 15 unaccented letters (A–Z, a–z) or digits; no spaces or punctuation.

CommitmentChoiceButtonOnlyboolean

Only with CommitmentChoice Accept or Reject; otherwise 400. Shows a single action button with CommitmentChoiceButtonText or the default Finish label instead of the standard Accept/Reject label. It does not hide the comment field.

QERDSIdentityTenantstring

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.

CostCentrestring

An arbitrary cost-centre label recorded with the transaction for internal billing allocation.

EnforceTrackingUntilTimeToLiveboolean

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.

DisableSenderHeaderboolean

When true, the Sender header is removed from the recipient notification email.

DisablePlatformReferencesboolean

When true, internal platform references are suppressed in the generated affidavits.

LtaStorageboolean

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.

AllowRefusalboolean

When true, the recipient can explicitly refuse the notice before reading it (records a Refused outcome).

OnlineRetentionPeriodinteger, [ 1 .. 20 ]

Online custody period in years: 1 to 20 years; with by-submission billing your voucher tier can impose a lower maximum.

NotaryRetentionboolean

When true, the evidence is placed under notarial deposit. Requires NotaryProfile to be set.

NotaryProfilestring

The notary profile identifier to use for notarial deposit. Required when NotaryRetention is true.

Remindersobject(EviNoticeReminders)

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.

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"
  }'

Risposte

EviNotice accepted

Intestazioni
X-Evi-IdempotencyStatusstring

Idempotency outcome for the submission request.

Value:"New"
Corpoapplication/json
Idstring, (uuid)

The unique identifier of the submitted EviNotice. Use this to retrieve status and download evidence.

Risposta
{ "Id": "550e8400-e29b-41d4-a716-446655440000" }