This operation allows to submit an EviNotice with the following data:
*Note: The PIN code has a life time of 60 minutes, after this time it will be necessary to request another PIN code. The number of 9 attempts to correctly enter the PIN code sent is also established.
- CommitmentChoice [optional]: Text appearing to reach an agreement. Possible values are as follows:
- Disabled: (Default) There is no button.
- Accept: Text "Accept" appears and check "Accept" appears on the agreement page.
- Reject: Text "Reject" appears and check "Reject" appears on the agreement page
- AcceptOrReject: Text "Accept/Reject" appears and checks "Accept" and "Reject"appear on the agreement page.
- CommitmentCommentsAllowed [optional]: Boolean which indicates whether or not to include comments in the acceptance or rejection of the agreement.
- True: Comments are allowed. This is the default value, but "CommitmentChoice" must be different from "Disabled".
- False: (Default) Comments are not allowed.
- RejectReasons [optional]: Specifies a list of reasons for rejection, which will be displayed to the user in a drop-down so that he/she can select one of them, must be used together with the parameters:
- CommitmentOptions : “Reject” or “AcceptOrReject”
- CommitmentCommentsAllowed : True
- AcceptReasons [optional] : Specifies a list of acceptance reasons, which will be displayed to the user in a drop-down so that he/she can select one of them. must be used together with the parameters:
- CommitmentOptions : “Accept” or “AcceptorReject”
- CommitmentCommentsAllowed : True
- RequireRejectReason [optional]: Boolean parameter, which indicates whether it is mandatory to indicate a reason for rejection to confirm a notification. Default value is false. must be used together with the parameters:
- CommitmentOptions : “Reject” or “AcceptorReject”
- RequireAcceptReason [optional]: Boolean parameter, which indicates whether it is mandatory to indicate a reason for acceptance to confirm a notification. Default value is false. must be used together with the parameters:
- CommitmentOptions : “Accept” or “AcceptorReject”
- PushNotificationUrl [optional]: URL of contract’s issuer to which EVICERTIA will do a POST when an event related to the contract occurs, sending a JSON with information about the event Therefore, the issuer can develop a controller that allows to capture these requests and proceed to update the status of the contracts in its own information systems.
- PushNotificationFilter [optional]: List of Pushes you would like to be notified of in PushNotificationUrl. Possible values are:
- Processed: The EviNotice has been locally processed. It will be subsequently sent.
- Sent: The EviNotice has been sent to the server or the operator that manages the mailbox or device of recipient: from now on the system will manage the process of reception.
- Dispatched: The messaging service serving the recipient has accepted of the EviNotice and will then try to send it to the final recipient.
- Delivered: The EviNotice has been delivered to the final recipient, but the content still has not been opened/read.
- Received: The user has made use of the link attached to the EviNotice.
- Read: The EviNotice has been opened/read by the final recipient.
- Replied: The recipient has answered accepting or rejecting the EviNotice.
- Closed: End of the tracking of status, for which reason no more notifications or answers are expected and the notarial deposit will follow.
- Failed: The EviNotice has failed to be delivered to the recipient for any reason. This is not a final state.
- AffidavitPublished: A new Affidavit has been generated, it was requested on demand by the issuer and will contain the information collected so far.
- PushNotificationExtraData [optional]: Text field in which the issuer of the contract may indicate additional data. These data will be sent later in each push notification that is made.
- NotificationLayout [optional]: : It specifies if the EviNotice will appear with the CERTIFICATE logos, or it will be sent without logos for commercial purposes. Values to be displayed are as follows:
- Certified: (Default) Some logos are displayed.
- AsIs: No logos to be displayed.
- TimeToLive [optional]: Time (in minutes) that the EviNotice/contract will be available before proceeding to close the tracking of the EviNotice. In those cases in which the notification/contract is accessible via a link, once that period has elapsed and if it has never been accessed, this link is no longer available.
- OnlineRetentionPeriod [optional]: Time (in years) of online retention. Default value is 1 year. This parameter is important for invoicing purposes.
- NotaryRetention [optional]: Boolean. If true, a 5-year notarial retention will be applied; otherwise nothing will be applied. This parameter is important for invoicing purposes.
- NotaryProfile [optional]: Notary’s identifier who will carry out custody at the notary’s office This parameter must be reported if NotaryRetention is true.
- Language [optional]: It represents the evidence language. Values that can be indicated are type:
- en (Default)
- es
- ca
- it
- pt
- fr
- de
- ro
- AffidavitLanguage [optional]: It represents the language in which you want to generate the Affidavits. Values that can be indicated are type:
- CostCentre [optional]: In terms of invoicing, it allows to group sendings. In order to automate invoicing and to allocate expense.
- AllowRefusal [optional]: Indicates whether the recipient is given the option to refuse to view the content of a notification. By default its value is False. Possible values are:
- True: The recipient is given the option to refuse to view the content of a notification.
- False: (Default) The recipient has no option to decline.
- SmsNotifyTemplate [optional]: Template to be used by SMS.
- NotificationTemplate: Contains the identifier of the template to be used in the communication..
- NotificationTemplateValues: It contains an array of value keys, where the variables defined in the template content and the value it receives in the emission are reported.
- Reminders: Set how often notification reminders will be made.
- Initial: String, time interval in ISO8601 format specifying the number of days or weeks after which the first notification reminder will be issued (from the EviNotice issue date).
- Repeat: String, Time interval in ISO8601 format indicating the frequency with which the set configuration for notification reminders is repeated.
- Days: Array, indicates the days of the week on which notification reminders will be sent. This field is configured as a list of the days of the week in English, separated by ",". Default: [ Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday ]
- TimeRange: Array, indicates the time ranges selected for sending notification reminders. Allowed time ranges:
- FROM08TO10: 08:00 - 10:00
- FROM10TO12: 10:00 - 12:00
- FROM12TO15: 12:00 - 15:00
- FROM15TO19: 15:00 - 19:00
- FROM19TO22: 19:00 - 22:00
- Default: [FROM08TO10, FROM10TO12, FROM12TO15, FROM15TO19, FROM19TO22]
- Max: Number, indicates the maximum number of notification reminders that can be sent during the lifetime of the process.
- Stop: String, time interval in ISO8601 format representing the deadline for sending the last notification reminder.
- TimeZone: String, name of the TimeZone (with the values of the TimeZones Etc/GMT) to be used for the calculation of the time when the reminders will be sent. Default: Etc/GMT0
POST https://app.ecertia.com/api/v2/EviNotice/Submit HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX==
Host: app.ecertia.com
{
"Subject": "Hello world",
"Body": "Lorem ipsum dolor sit amet",
"RecipientAddress": "pruebas@evicertia.com",
"IssuerLegalName": "Evicertia",
"LookupKey": "dev",
"Attachments": [
{
"FileName" : "Example.pdf",
"Data": "Pdf's B64."
}
],
"CertificationLevel": "Advanced",
"AffidavitKinds": ["SubmittedAdvanced", "CompleteAdvanced", "OnDemand"],
"CommitmentChoice": "AcceptOrReject",
"CommitmentCommentsAllowed": true,
"PushNotificationUrl": "https://www.mysite.org/url/to/push",
"PushNotificationFilter": ["Processed", "Sent", "Received"],
"OnlineRetentionPeriod": 10,
"Language": "es",
"AffidavitLanguage": "es"
}
In case of successful sending, the identifier allocated to the evidence that can be used later to consult its state is returned.
{
"Id":"dd24e27d-2d84-4f74-a7f0-a23b018ab798"
}
Push notifications
{
"Identifier": "0188d313-e2a9-4293-b995-c36324c889a7",
"Kind": "Received",
"Date": "2023-06-19T09:54:35.7608150Z",
"EvidenceId": "0188d313642147089ab0c1398514df49",
"EvidenceType": "eviNotice",
"Site": "xxxxxx",
"OwnerEmail": "xxx@correo.es",
"AdditionalData": {
"From": "xxxx@correo.es",
"To": "xxxx@correo.com",
"Subject": "notification about your insurance car",
"State": "Received",
"CreationDate": "2023-06-19T09:54:03.7486430Z",
"Progress": "Received of the notification confirmed",
"Description": "The system confirmed, via open link, that the recipient received the notification with an attached link allowing the user to access the content, but the content has not yet been opened/read.",
"IpAddress": "188.26.211.105",
"BrowserData": "Chrome",
"UserLanguages": "es-ES, es;q=0.9"
}
}
Idempotence Activation
There is the option to activate the idempotency capability to avoid sending the same EviNotice more than once in case of repeated submitting. For that, a request with the name "X-Evi-IdempotencyToken" must be added to the request headers, adding as a value some random text (the use of a GUID is recommended).
More information is given below and examples of the parameters are given, so that they are understood more easily. This section is organized in alphabetical order.