Sign the document
Requirements
- Authentication token
- Document ID
- Document version
How to:
1. Seal the document
PUT /documents/seal/:version?token=:authenticationToken
- Seals document main file.
Example
Request
PUT /documents/seal/3?token=ADFFQBYXP2NVGR6PAP3KOR27FETP6
{
"id": "d148b19a-4fa9-442e-adfd-7aa68b8eb766"
}
Response
- No response, only status 200.
2. Sign the document
PUT /documents/sign/:version?token=:authenticationToken
- Signs given document.
Example
Request
PUT /documents/sign/3?token=ADFFQBYXP2NVGR6PAP3KOR27FETP6
{
"type": "d_integration",
"id": "d148b19a-4fa9-442e-adfd-7aa68b8eb766",
"annotations": [{
signee: "simpson.h@circularo.com", //who signs the document
page: 1, //annotations position
percentX: 0.45,
percentY: 0.75,
percentWidth: 0.1,
percentHeight: 0.05,
align: "left",
fontSize: 12,
text: "My annotation" //annotation text
}] //see swagger for complete documentation
}
- NOTE: At least one of signatures, annotations and images properties must be specified in the object body.
Response
- No response, only status 200.
3. Share sign the document
POST /share?token=:authenticationToken
- Shares the document to other users to sign it.
- You can choose multiple participants
- In case of external user, you can protect the share using either password or OTP.
- In case of OTP you have to specify recipient phone number or email, on which the authentication code will be sent.
- If you select multiple participants, you can choose whether they have to sign the document sequentialy (one-by-one) or they can sign it at once.
- You can choose one of sign types: signature, initials, stamp, wacom, annotation, and image
- Participants get notification or e-mail with link to access the document.
Example
Request
PUT /share/?token=ADFFQBYXP2NVGR6PAP3KOR27FETP6
{
"objectType": "document",
"type": "d_integration",
"id": "d148b19a-4fa9-442e-adfd-7aa68b8eb766",
"data": [ //specify at least one participant
{
"sharePurpose": "sign",
"shareTo": "bill.taylor789@gmail.com", //external user
"message": "Sign me", //private message
"validUntil": "2020-02-11T19:10:10.100Z", //ISO 8601 format
"otpEnabled": true, //or use password or let it unsecured
"phone": "4453217784" //OTP phone number, or use e-mail address instead
}, {
"sharePurpose": "sign",
"shareTo": "kim.black", //internal user
"message": "Sign me, please", //private message
"validUntil": "2020-02-12T19:10:10.100Z" //share validity
}
],
"signatureFields": [
{
"user": "bill.taylor789@gmail.com",
"timestamp": false,
"required": true,
"tooltip": "Signature tooltip text",
"type": "signature", //sign type is signature
"page": 3, //document page with sign
"position": { //position and size at the page
"percentX": 0.5,
"percentY": 0.1,
"percentWidth": 0.2,
"percentHeight": 0.05
}
}, {
"user": "kim.black",
"timestamp": true,
"required": true,
"tooltip": "Stamp tooltip text",
"type": "stamp", //sign type is stamp
"page": 4,
"position": {
"percentX": 0.3,
"percentY": 0.65,
"percentWidth": 0.15,
"percentHeight": 0.15
}
}
]
"sequential": true, //recipients are required to sign one-by-one
}
Response
[
{
"shareId": "7d746a2d9fd447b11bb870b69192df8c0933892aba0c2d15468ed85d79095948",
"isActive": true,
"shareDate": "2020-02-11T16:16:16.150Z",
"shareType": "sign",
"sharedBy": "judy.corbett",
"sharedObjectEsId": "d148b19a-4fa9-442e-adfd-7aa68b8eb766",
"sharedObjectEsType": "d_integration",
"sharedObjectType": "document",
"sharedWith": [ "bill.taylor789@gmail.com" ],
"otpEnabled": true,
"otpPhone": "**84"
"passwordRequired": false,
"privateMessage": "Sign me",
"validUntil": "2020-02-11T19:10:10.100Z",
"sequential": true
}, {
"shareId": "7a9p0ac5a2qkgis1am9nix37wifhryj4g5sdhtux578qwel0cposx51asurt23qe",
"isActive": true,
"shareDate": "2020-02-11T16:16:16.150Z",
"shareType": "sign",
"sharedBy": "judy.corbett",
"sharedObjectEsId": "d148b19a-4fa9-442e-adfd-7aa68b8eb766",
"sharedObjectEsType": "d_integration",
"sharedObjectType": "document",
"sharedWith": [ "kim.black@circularo.com" ],
"otpEnabled": false,
"passwordRequired": false,
"sharedUsername": "kim.black",
"privateMessage": "Sign me, please",
"validUntil": "2020-02-11T19:10:10.100Z",
"sequential": true
}
]
Please note the share IDs. These are used by the external participants to access the document.
- External user bill.taylor789@gmail.com gets an e-mail notification with link.
- Link is in format
<frontendUrl>/#!/share?shareId=<shareId>
- https://frontendUrl/#!/share?shareId=7d746a2d9fd447b11bb870b69192df8c0933892aba0c2d15468ed85d79095948
- Link is in format
- Internal user kim.black gets either in-app or e-mail notification with link.
- Link is in format
<frontendUrl>/#!/sign/<documentId>/<documentType>
- https://frontendUrl/#!/sign/d148b19a-4fa9-442e-adfd-7aa68b8eb766/d_integration
- Link is in format