Delivering Signed Documents
Once a transaction has been completed, you can automatically deliver the signed documents to your signers. The following code will do this:
HTTP Request
POST <host domain>/api/sign/v1/cs-packages/{packageId}/roles
HTTP Headers
Accept: application/json Content-Type: application/json Authorization: Bearer access_token
Request Payload
{ "id": "Signer5", "reassign": true, "type": "SIGNER", "signers": [ { "email": "signer5@example.com", "firstName": "John", "lastName": "Smith", "id": "Signer5", "delivery": { "email": true, "download": true, "provider": true } } ], "name": "Signer5" }
For a complete description of each field, see the Request Payload Table below.
Response Payload
{ "id": "Signer5", "data": null, "specialTypes": [], "emailMessage": null, "attachmentRequirements": [], "locked": false, "reassign": true, "index": 0, "signers": [ { "group": null, "language": "en", "signature": null, "id": "Signer5", "delivery": { "provider": true, "email": true, "download": true }, "auth": { "scheme": "NONE", "challenges": [] }, "knowledgeBasedAuthentication": null, "data": null, "title": "", "company": "", "email": "signer5@example.com", "firstName": "John", "lastName": "Smith", "external": null, "updated": "2017-11-16T16:53:01Z", "phone": "", "professionalIdentityFields": [], "userCustomFields": [], "address": null, "created": "2017-11-16T16:53:01Z", "name": "", "specialTypes": [] } ], "name": "Signer5", "type": "SIGNER" }
Request Payload Table
Property |
Type |
Editable |
Required |
Default |
Sample Values |
---|---|---|---|---|---|
id |
string |
Yes |
No |
n/a |
|
reassign |
boolean |
Yes |
No |
false |
|
name |
string |
Yes |
No |
n/a |
|
type |
string |
Yes |
No |
SIGNER |
|
signers | |||||
|
string |
Yes |
No |
n/a | |
firstName |
string |
Yes |
No |
n/a |
|
lastName |
string |
Yes |
No |
n/a |
|
id |
string |
Yes |
No |
n/a |
|
delivery | |||||
|
boolean |
Yes |
No |
false |
|
download |
boolean |
Yes |
No |
false |
|
provider |
boolean |
Yes |
No |
false |
|