Enforcing Signature Capture
In Conga Sign, signers will only be asked to draw their signature once by default. If the transaction requires multiple signatures on the document, Conga Sign will automatically replicate the first drawn signature for any subsequent signatures. However, you have the option to require your signer to draw their signature on any given capture signature. This topic will focus on enforcing signature capture at the signature level.
Enforcing Capture Signature
The sample request below shows you how to set enforceCaptureSignature: true at the approval level.
HTTP Request
POST <host domain>/api/sign/v1/cs-packages
HTTP Headers
Accept: application/json Content-Type: application/json Authorization: Bearer access_token
Request Payload
------WebKitFormBoundary1bNO60n7FqP5WO4t Content-Disposition: form-data; name="file"; filename="enforce capture signature.pdf" Content-Type: application/pdf %PDF-1.5 %µµµµ 1 0 obj <>>> endobj.... ------WebKitFormBoundary1bNO60n7FqP5WO4t Content-Disposition: form-data; name="payload" { "documents": [ { "approvals": [ { "fields": [ { "height": 50, "id": "Signature1", "left": 100, "page": 0, "subtype": "CAPTURE", "top": 100, "type": "SIGNATURE", "width": 200 } ], "id": "Signature1", "role": "signer1" }, { "fields": [ { "height": 50, "id": "Signature2", "left": 100, "page": 0, "subtype": "CAPTURE", "top": 200, "type": "SIGNATURE", "width": 200 } ], "id": "Signature2", "role": "signer1", "enforceCaptureSignature": true }, { "fields": [ { "height": 50, "id": "Signature3", "left": 100, "page": 0, "subtype": "CAPTURE", "top": 300, "type": "SIGNATURE", "width": 200 } ], "id": "Signature3", "role": "signer1" } ], "name": "Document1", "id": "Document1" } ], "name": "test Enforce Capture at Signature Level", "roles": [ { "id": "signer1", "signers": [ { "email": "signer1@example.com", "firstName": "John", "id": "signer1", "lastName": "Smith" } ] } ], "type": "PACKAGE", "status": "SENT" } ------WebKitFormBoundary1bNO60n7FqP5WO4t--For a complete description of each field, see the Request Payload Table below.
Response Payload
{ "id": "Q6v0Tn_v62G5tfRY43VBE-TEbU4=" }- “By default, “enforceCaptureSignature" is set to false at both the transaction and signature levels. This means you do not need to do anything if you do not want to use this feature.
- Unlike the enforceCaptureSignature true setting in the transaction level, which requires the signer to capture the signature every capture approval, at the signature level enforceCaptureSignature only forces the signer to capture their signature when the approval contains the "true" setting.
Request Payload Table
|
Property |
Type |
Editable |
Required |
Default |
Sample Values |
|---|---|---|---|---|---|
|
status |
string |
Yes |
No |
DRAFT |
|
|
type |
string |
Yes |
No |
PACKAGE |
|
|
name |
string |
Yes |
No |
n/a |
|
|
documents | |||||
|
name |
string |
Yes |
No |
n/a |
|
|
approvals | |||||
|
fields | |||||
|
subtype |
string |
Yes |
No |
n/a |
|
|
type |
string |
Yes |
No |
n/a |
|
|
extract |
boolean |
Yes |
No |
false |
|
|
height |
integer |
Yes |
No |
50 |
50/100/150... |
|
left |
integer |
Yes |
No |
0 |
50/100/150... |
|
page |
integer |
Yes |
No |
0 |
0/1/2... |
|
top |
integer |
Yes |
No |
0 |
50/100/150... |
|
width |
integer |
Yes |
No |
200 |
50/100/150... |
|
role |
string |
Yes |
No |
n/a |
|
|
enforceCaptureSignature |
boolean |
Yes |
No |
false |
|
|
roles | |||||
|
id |
string |
Yes |
No |
n/a |
|
|
name |
string |
Yes |
No |
n/a |
|
|
type |
string |
Yes |
No |
SIGNER |
|
|
signers | |||||
|
|
string |
Yes |
Yes |
n/a | |
|
firstName |
string |
Yes |
Yes |
n/a |
|
|
lastName |
string |
Yes |
Yes |
n/a |
|
|
phone |
string |
Yes |
No |
n/a |
|
|
id |
string |
Yes |
No |
n/a |
|
|
company |
string |
Yes |
No |
n/a |
|
|
title |
string |
Yes |
No |
n/a |
|
