...
- LookupKey[optional]: Identifier allocated by the user, it can be used later to locate an evidence through the query web service (EviSignQuery).
- Subject: Subject of the contract to be sent.
- Document: Document or contract to be signed by the parties (in PDF format).
- SigningParties: List of signers of the document, with the following data for each signer:
- Name: Full name of the person who must sign the document/contract.
- Address: E-mail address or telephone number of the signer, to which the signature request will be sent.
- SigningOrder: Order in which the signers will have the opportunity to sign the document and attachment(s) where appropriate. If not specified, it will be sent to all of them at the same time. It is a positive integer, and the same value can be specified for more than one signer. This allows a particular group of signers to sign at the same time, even before or after other signers sign.
- SigningMethod: Type of signature to request. [More information on section "Examples and further information about parameters"]:
- Challenge: Challenge question/answer. The operation will be carried out if the question selected as challenge by the issuer to be answered correctly.
- EmailPin: Security code PIN sent to e-mail. The operation will be carried out after identifying the user that accesses or signs, requesting a random PIN sent to his e-mail address.
- Handwriting: Digitalized signature. Handwritten digitalized signature or dynamic biometrics signature, depending on the capture device.
- MobilePin: Security code PIN sent to mobile phone. The operation will be carried out after identifying the user that accesses or signs, requesting a random PIN sent to his mobile phone.
- WebClick: Click in web through safe link or locator. The operation will be carried out if the reference or locator of the message is known.
- Other values that should only be reported if the corresponding method has been selected are as follows:
- PhoneNumber: Mobile phone number to send the PIN to when the signing method is MobilePin.
- AllowVoicePinFallback: It indicates whether the signer can choose to be informed of the signature PIN by voice call, in case PIN forwarding is requested. Only applicable when the signature method is MobilePin.
- WhatsAppPinPolicy: Indicates the default value for the PIN sending policy by WhatsApp. It only applies when the signature method is MobilePin.
- Disabled: The WhatsApp channel is not enabled to send the PIN. Corresponds to the Normal delivery policy (by SMS).
- Optional: The WhatsApp channel is enabled to send the PIN as an alternative to SMS.
- Fallback: The WhatsApp channel is enabled to send the PIN only on retry.
- SignDelivery: Obsolete. Since August 2018 this parameter is obsolete and is only maintained for backward compatibility reasons. You must use the SignStep parameter that is explained on this page.
- EmailAddress: Email account to send the PIN to when the chosen method is EmailPin.
- SignatureChallenge: Question asked when the signature method is Challenge.
- SignatureChallengeResponse: Answer to the previous question.
- AddressType: Via by which you want to notify the signer. It can be through a phone number "PhoneNumber" or an email account "Email".
*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.
- SignerGeoLocationPolicy [Optional]: This setting allows the sender to request the browser location data from the signer during the signing process.
- Required: The collection of coordinates is enabled and also mandatory for the signature.
- Enabled: Collection of coordinates enabled but not mandatory for signature.
- Disabled: Coordinates collection for signature disabled.
- LegalName: Legal name, tax id, identity document and/or full name of the individual recipient of the message (the more identifying data the better).
- DisableSignRequests: It disables sending a notification or any signature request reminder/forwarding to the notification address. The signature will be carried out using a tablet or through representative signature. It can only contain two values “true” or "false". If "true" the signature request is not sent. Incompatible with AttachToSignatureRequest/SignatureRequestInfoText if all signers set it to “true”. By default is "false".
- DisableFinalNotification: It disables the sending of the final notification to the signer once signed/rejected. It can only contain two values "true" or “false”. If "true" the final notification is not sent. This option is incompatible with AttachToFinalNotification o FinalNotificationInfoText if all signers set it to “true”. By default is "false".
- DisableStateNotifications: It disables the sending of state change notifications to the signer (for example, expire or cancelled). It can only contain two values "true" or "false". If "true" state change notifications are not sent. By default is "false".
- RequiresCaptcha: Enable turing test (captcha) in the signature. It can only contain two values "true" or "false". If "true" the captcha is disabled.
- SignatureAppearances: Information about the geometric position in which the signature must be entered in the contract. [More information on section "Examples and further information about parameters"]:
- This position is indicated by including the position in JSON format.
- AllowOverride: It indicates whether or not to change the signer. NOTE: this property is obsolete and it will disappear.
- SignatureQuestions: List of questions the signer must answer during the signature process. There can be several questions, and they are all included in the node SignatureQuestion. [More information on section "Examples and further information about parameters"]:
- NOTE: Contact support@evicertia.com, before using this node.
- NOTE: It is highly important to respect "case sensitive" of parameter TypeName.
- Key: Question identifier, which will serve the transmitting system to find the answer given by the user. It is recommended to include unique words such as NIF, Account, email.
- Label: Text to be shown to the user as a question to enter.
- TypeName: Identifier of the type of question, which will allow the validation of the data entered by the signer. It is important to respect "case sensitive" of the names shown below:
- SpanishDocumentId: Identity document with validation of NIF, NIE and company’s NIF.
- DocumentId: Identity document without validation.
- BankAccount: Bank account (letters and numbers without restrictions).
- BankAccountES: Old Spanish bank account or CCC (legacy).
- BankAccountIBAN: -> European bank account where the account is not validated, only the IBAN control digit.
- BankAccountIBANES: -> Bank account with Spanish IBAN (both IBAN control digit of bank account are validated).
- EmailAddress: Email with validation of being well formed, but it does not validate if it is a valid address or the signer's address.
- IntlVatId: Tax identifier.
- SwiftCode: SWIFT code.
- SpanishVatId: Spanish tax identifier.
- PhoneNumber: Telephone number in international format (por example, +34914237080).
- Password: Password.
- Text: Text: letters, numbers and/or punctuation marks with the value of the requested data.
- MultiLineText: Multiline text: several lines with letters, numbers and/or punctuation marks with the value of the requested data.
- Number: Integer with sign.
- Decimal: Number with decimals and/or sign.
- Date: Date in format dd-mm-yyyy.
- CheckBox: Mark or unmark the checkbox.
- SelectList: Choose one option from the list.
- Image: Upload an image or photo.
- File: Attach file.
- DynamicSignature: Visual representation of the handwritten signature along with biometric information.
- DefaultValue: Default value to be displayed.
- Required: It indicates if the signer must compulsorily answer the question.
- Language: Represents the language in which you want to see some data of the notifications and that are provided by the operating system or the browser (culture). Values that can be indicated are type: es (for Spanish), en (for English), ca (for Catalan), pt (for Portuguese) and fr (for French).
- In case of indicating a Language that does not exist, a CultureNotFoundException is displayed.
- Role: The signer’s role. He can be:
- Signer: Signer.
- Reviewer: Reviewer. He/she can accept or reject the EviSign, but he/she does not appear as the signer.
- SignStep: Time when signature process is carried out. More information clicking here
- FinalNotificationAddress: It represents the email address to which the final notification will be sent.
- DeliverySubDomain: Registered Delivery Channel identifier to upload the signature portal from an iframe.
- DeliveryCustomUrl: Redirect URL for the signer to access the appropriate Delivery Channel. Optional, it can only be indicated if DeliverySubDomain is reported.
- DeliveryWebView: Registered Delivery Channel identifier to upload the signature portal from a mobile app.
- DelegatedSignature: Indicates if delegated signature is activated
- WhatsAppPinPolicy: Indicates the default value for the PIN sending policy by WhatsApp. It only applies when the signature method is MobilePin.
- Disabled: The WhatsApp channel is not enabled to send the PIN. Corresponds to the Normal delivery policy (by SMS).
- Optional: The WhatsApp channel is enabled to send the PIN as an alternative to SMS.
- Fallback: The WhatsApp channel is enabled to send the PIN only on retry.
- SignatureRequestTemplate: Contains the identifier of the template to be used in the signature request communication.
- SignatureRequestTemplateValues: 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.
- SignatureReminderTemplate: Contains the identifier of the template to be used in the reminder communication.
- SignatureReminderTemplateValues: 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.
- FinalNotificacionTemplate: Contains the identifier of the template to be used in the final notification communication.
- FinalNotificacionTemplateValues: 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.
ProgressNotificationTemplateName- ProgressNotificationTemplate: Contains the identifier of the template to be used in the progress communication.
- ProgressNotificationTemplateValues: 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.
- InterestedParties: List of interested parties of the document, with the following data for each interested party:
- Name: Full name of the person receiving the information.
- LegalName: Legal name, tax id, identity document and/or full name of the individual recipient of the message (the more identifying data the better).
- Address: E-mail address of the interested party to whom the notification will be sent once the document has been signed.
- Options: OSendingSending/processing options of the message:
...
Code Block |
---|
title | Example of a push notification answer (SENT) |
---|
|
{
"Identifier": "dd9f60e5-c880-4c67-8aee-a87000e1b20e",
"EvidenceId": "00b17d3bfd564dedad32a87000d12f02",
"EvidenceType": "eviSign",
"Kind": "Sent",
"Date": "2018-01-22T13:41:42.8767119+01:00",
"Site": "pruebas",
"Owner": "Pruebas evicertia",
"OwnerEmail": "pruebas@evicertia.com",
"AdditionalData": {
"SignerName": "Pruebas Evicertia (AllowOverride)",
"SignerNotificationAddres": "pruebas-firmante@evicertia.com",
"SignerNotificationAddresType": "EmailAddress",
"EventDescription": "Sent",
"SignerRole": "Signer"
"TransmissionSuccess": true
"TransmissionDescription": "The signature request has been sent to pruebas-firmante@evicertia.com"
"Retry": 1,
"ExtraData": "{\"myId\": \"99cf386b-1590-4ddb-af68-607b3e7c1194\", \"myCreationDate\": \"2018-01-22T12:54:00.4367924+01:00\"}
}
} |
...