Page Comparison

Web service parameters

This operation allows to submit from EVICERTIA an EviSign contract with the following data:

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

...

SecurityTags: Security labels, and they serve to control access to an EviSign. Only users with the same tag will be able to access the same document.
- It is important to note that tags must be less than 16 characters, and there can only be one tag per EviSign.
- In the case of Rest/JSON it must be reported as indicated in the specifications below.
PushNotificationUrl: 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. In case of not being able to push the indicated URL, the platform has a system of 10 retries with the following times between retries: 30 Seconds, 30 Seconds, 2 minutes, 5 minutes, 10 minutes, 30 minutes, 1 Hour, 5 Hours, 15 hours, 1 Day and 6 Hours.
PushNotificationFilter: List of events you would like to be notified of in PushNotificationUrl. Possible values are:
- Processed: The contract has been admitted in the system and is ready to be sent.
- Sent: The signature notification has been sent to the signer.
- Delivered: Confirmation of delivery of signature notification to the signer has been received.
- Signed: The signer has signed the contract.
- Rejected: The signer has rejected the contract.
- FullySigned: All the signers have signed the contract.
- FullySent: The signature request has been sent to all the signers.
- FullyDelivered: The signature request has been delivered to all the signers.
- Closed: The contract is closed, no further events are expected.
- AffidavitPublished: A new Affidavit has been generated, it was requested on demand by the issuer and will contain the information collected so far.
PushNotificationExtraData: 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.

InterestedPartiesNotifications: List of events you would like to be notified to interested parties. Possible values are

Sent: Notifies when the EviSign has been sent to all parties.
FinalNotificationSent: Notifies when the final signature notification has been sent.
Signed: Notifies when the EviSign has been signed by all parties.
PartySigned: Notifies when one of the parties has signed.
Rejected: Notifies when an EviSign has been rejected.
Expired: Notifies when an EviSign has expired
Failed: Notifies when an error has occurred during the life cycle of an EviSign.

Cancelled: Notifies when an EviSign signature has been cancelled.

Code Block

title	How to set interested parties notifications

{
    "subject": "Example interestedParties",
    "signingParties": [
        {
            "address": "Signer@signermail.com",
            "Name": "Signer name ",
            "signingMethod": "WebClick"
        }
    ],
    "interestedParties": [
        {
            "name": "Interested partie name 1",
            "legalName": "111114C",
            "address": "Interestedpartie1@interestedmail.com"
        },
        {
            "name": "Interested partie name 2",
            "legalName": "111115C",
            "address": "Interestedpartie2@interestedmail.com"
        }
    ],
    "options": {
        "interestedPartiesNotifications": [
            "sent",
            "signed",
            "cancelled"
        ]
    },
    "document": "{{documentBase64}}"
}

Attachments: List [optional] with message attachments.

DisplayName: Name of the attachment.
FileName: Name of the file.
MimeType[optional]: Information on mime type of attachment.
ContentId[optional]: Mime identifier of the attachment.
ContentDescription[optional]: Mime description of the attachment.
Data: Content (bytes) of the file to be attached.

Attributes[optional]: Attributes that we want to indicate about the attachment:

Attribute: This property will contain as many Attribute nodes as needed and within them different key-values are allocated:
- Key: Name of the key.
- Value: Value for the previous key.
Here below are the key-values that can be used in this node:
- Key = RequireContentCommitment, Value = true, indicates that attachments must be signed, regardless of the contract itself.
- Key = RequireContentCommitmentOrder, Value = Number, indicates the order number in which the attachment will be displayed:
  - After the Main Document: Positive value greater than '0'.
  - Before the Main Document: Negative value lower than '0'.
  - Notes:
    - Values must be other than 0.
    - For multiple attachments, the values must be different and will be are sorted from highest negative to highest positive.

Here below there is an example of a node attachment with a node attributes.

Code Block

 

			[
				{
					"UniqueId":"00000000-0000-0000-0000-000000000000",
					"CreationDate":"0001-01-01T00:00:00",
					"EvidenceUniqueId":"00000000-0000-0000-0000-000000000000",
					"DisplayName":"4kb.pdf",
					"Filename":"4kb.pdf",
					"Data":"[ATTENTION: attachment BASE64 in PDF format would appear here]",
					"Attributes": [
						{
							"Key":"RequireContentCommitment",
							"Value":true
						},
						{
							"Key":"RequireContentCommitmentOrder",
							"Value":1
						}
					]
				}
			]

...

Versions Compared

Old Version 38

New Version 39

Key

Web service parameters