Additional Notes
1. Coordinates of the signature image
The two type of coodinates used by LivecConsent Create Request function to place a signature image are pdf and web:
- if coordinates_type is "pdf" the format is: "x,y" where x is the x coordinate bottom left reference (PDF reference), y is the y coordinate bottom left reference (PDF reference). "x" and "y" are positive float numbers. Example: "400,700" or "200,500.52"
- if coordinates_type is "web" the format is: "x,y" where x is the x coordinate top left reference, y is the y coordinate top left reference. Example: "400,700".
To easily get web coordinates, you can use our "Place signature" tool: https://api.liveconsent.com/placesignature
2. Size of the signature image
Size of the signature image can be set with height or width value. The image will be scaled depending on the height or width parameter to the default signature box appearance:
- if coordinates_type is "pdf", then <height_size> or <width_size> are positive float numbers for represented dimension on PDF reference. Example: "h,68" or "w,142.52".
- if coordinates_type is "web", then <height_size> or <width_size> are positive numbers for represented dimension on web reference. Example: "h,92" or "w,192". For "web" coordinates_type default signature image size is height_size=92 or width_size=192.
Default signature size values for "pdf" and "web" selected coordinates_type are available on our "Place signature" tool: https://api.liveconsent.com/placesignature
3. Communication language
When a request is sent:
- if the recipient is not a LCS user, then the email is sent in requester's language;
- if the recipient is a LCS user, then the email is sent in recipient's language.
4. Signing order
If signatures_order in the request object is set to true, then:
- the recipients that are signers will be notified one after another, in the specified order
- the signing order applies only to recipients that are signers. All recipients that are observers are notified when the request is created, without taking into account the defined order
5. Request delivery via SMS
Setting sms_request_delivery to true is subject to an option available only on request.
SMS delivered to recipients contains a short URL to the LCS Request.
Please contact us on liveconsent.com, on our support platform or via email on mailto:[email protected]
6. Multiple documents request
The default developer account allows creation of LiveConsent Requests with only one document – one entry in documents JSON Array. LiveConsent Requests with multiple documents is available only by request.
Please contact us on liveconsent.com, on our support platform or via email on mailto:[email protected]
7. Request with custom number of validity days
The default developer account allows creation of LiveConsent Requests with request_validity_days period for only 30 days. Creation of LiveConsent Requests with different validity period is available only by request.
Please contact us on liveconsent.com, on our support platform or via email on mailto:[email protected]
8. Coordinates of the initials box image
The two type of coodinates used by LivecConsent Create Request function to place an initials box image are pdf and web:
- if coordinates_type is "pdf" the format is: "x,y" where x is the x coordinate bottom left reference (PDF reference), y is the y coordinate bottom left reference (PDF reference). "x" and "y" are positive float numbers. Example: "400,700" or "200,500.52"
- if coordinates_type is "web" the format is: "x,y" where x is the x coordinate top left reference, y is the y coordinate top left reference. Example: "400,700".
To easily get web coordinates, you can use our "Place signature" tool: https://api.liveconsent.com/placesignature
9. Size of the initials box image
Size of the initials box image can be set with height or width value. The image will be scaled depending on the height or width parameter to the default initials box appearance:
- if coordinates_type is "pdf", then <height_size> or <width_size> are positive float numbers for represented dimension on PDF reference. Example: "h,68" or "w,142.52".
- if coordinates_type is "web", then <height_size> or <width_size> are positive numbers for represented dimension on web reference. Example: "h,30" or "w,80". For "web" coordinates_type default initials box size is height_size=30 or width_size=80.
10. Disable LiveConsent Request notifications
LCS Request Life Cycle notifications are carried out by LCS in the default LCS Request configuration. This can be disabled with the "request_notifications" parameter set to false on Create Request function.
LCS Request Life Cycle notifications affected by "request_notifications" parameter are:
- Initial notifications; Subject: Document(s) to sign from {requester name}, Document(s) to read from {requester name}, Document(s) to validate from {requester name}
- Automatic reminders; Subject: Document(s) to sign from {requester name} (Reminder), Document(s) to read from {requester name} (Reminder)
- Request Live Cycle notifications:
- Request Signed; Subject: Document signed
- Request Rejected; Subject: {signer name} - disagreement
- Request with added extra time; Subject: Document(s) to sign from {requester name} (Reminder), Document(s) to read from {requester name} (Reminder)
Obs!
Request Abandoned notification to all recipients (Subject: Request abandoned) can be disabled on Abandon Request function with "send_notification" parameter set to false.
Exemples of JSON for Create Request
- Example of HTTP Request JSON Body data for an LCS request with 2 documents, 2 recipients where first recipient has to sign 2 times and the second recipient has to sign 1 time:
{
"request": {
"request_name": "Request DOC20160725 1043",
"unique_submit_id": "UniqueID1",
"access_code_required": true,
"request_notify_open": true,
"request_create_draft": false,
"request_message": "request message for approvers",
"request_callback_url": "https://your.website.url/status_update.php",
"signatures_order": true,
"request_custom": "Defined custom for request_custom",
"request_metadata": "<meta1>Value meta1</meta1><meta2>Value meta2</meta2>",
"request_notify_signature": true
},
"documents": [
{
"document_type": "url",
"document_content": "http://www.mydomain.com/testdocument1.pdf",
"document_filename": "testdocument1.pdf",
"document_checksum_algorithm": "sha256",
"document_checksum": "aaefa1e855a6941498464465bc19383b6fa7f4b10434abed29e1d73f4bc245d6",
"document_custom": "MYDOC1",
"document_metadata": "<docmeta1>Value docmeta1</docmeta1><docmeta2>Value docmeta2</docmeta2>"
}
],
"recipients": [
{
"firstname": "Firstname1",
"lastname": "Lastname",
"code_delivery": "email",
"email": "[email protected]",
"phone": "+33000000001",
"order": 1
},
{
"firstname": "Signer2",
"lastname": "Test",
"code_delivery": "sms",
"email": "[email protected]",
"phone": "+33000000002",
"order": 2,
"company": "Company Name ACME",
"return_url": "urlSigner2",
"signature_visual": "draw_it"
}
],
"signatures": [
{
"signature_document": "testdocument1.pdf",
"signature_recipient": "[email protected]",
"signature_page_number": 1,
"coordinates_type": "web",
"signature_position": "400,700"
},
{
"signature_document": "testdocument1.pdf",
"signature_recipient": "[email protected]",
"signature_page_number": 1,
"coordinates_type": "web",
"signature_position": "400,700",
"signature_size": "w,400",
"signature_type": "basic"
}
]
}
- Example of HTTP Request JSON Body data for an LCS request with 2 documents, 2 recipients where first recipient has to sign 2 times and the second recipient has to sign 1 time:
{
"request":
{
"request_name": "Request DOC20160725 1043",
"unique_submit_id": "UniqueID1",
"access_code_required": true,
"request_notify_open": true,
"request_create_draft": false,
"request_message": "request message for approvers",
"request_callback_url": "https://your.website.url/status_update.php",
"signatures_order": true,
"request_custom": "Defined custom for request_custom",
"request_metadata": "<meta1>Value meta1</meta1><meta2>Value meta2</meta2>",
"request_notify_signature": true
},
"documents": [
{
"document_type": "url",
"document_content": "http://www.mydomain.com/testdocument1.pdf",
"document_filename": "testdocument1.pdf",
"document_checksum_algorithm": "sha256",
"document_checksum": "aaefa1e855a6941498464465bc19383b6fa7f4b10434abed29e1d73f4bc245d6",
"document_custom": "MYDOC1",
"document_metadata": "<docmeta1>Value docmeta1</docmeta1><docmeta2>Value docmeta2</docmeta2>"
}, {
"document_type": "url",
"document_content": "http://www.mydomain.com/testdocument2.pdf",
"document_filename": "testdocument2.pdf",
"document_name": "Document 2",
"document_checksum_algorithm": "sha256",
"document_checksum": "a315b93a30bd2eaf120cd433204621153a083ee987399c8a27dd8d7943dc5013"
}],
"recipients": [
{
"firstname": "Firstname1",
"lastname": "Lastname",
"code_delivery": "email",
"email": "[email protected]",
"phone": "+33000000001",
"order": 1
}, {
"firstname": "Signer2",
"lastname": "Test",
"code_delivery": "sms",
"email": "[email protected]",
"phone": "+33000000002",
"order": 2,
"company": "Company Name ACME",
"return_url": "urlSigner2",
"signature_visual": "draw_it"
}],
"signatures": [
{
"signature_document": "testdocument1.pdf",
"signature_recipient": "[email protected]",
"signature_page_number": 1,
"coordinates_type": "web",
"signature_position": "400,700"
}, {
"signature_document": "testdocument2.pdf",
"signature_recipient": "[email protected]",
"signature_page_number": 1,
"coordinates_type": "web",
"signature_position": "100,700",
"signature_size": "h,120"
}, {
"signature_document": "testdocument1.pdf",
"signature_recipient": "[email protected]",
"signature_page_number": 1,
"coordinates_type": "web",
"signature_position": "400,700",
"signature_size": "w,400",
"signature_type": "basic"
}]
}