Send Document Signature Request
Purpose
Upload a document file and send it for signature to multiple recipients.
Endpoint
POST {{host}}/api/v2/document/send?user_type=ENTERPRISE_API
Authentication
Requires user-token header for authentication.
| Header | Value | Description |
|---|---|---|
| user-token | {USER-TOKEN} | Authentication token |
Query Parameters
| Parameter | Required | Value | Description |
|---|---|---|---|
| user_type | Yes | ENTERPRISE_API | Specifies the API user type |
Request Body (multipart/form-data)
File Upload
| Field | Type | Description |
|---|---|---|
| file | File | The document file to be sent for signature |
Signature Mappings
| Field | Type | Description |
|---|---|---|
| mappings | JSON | JSON array defining signature field placements |
Mappings JSON Structure:
{
"signatures": [
{
"id": 0,
"x": 100,
"y": 200,
"width": 150,
"height": 50,
"pageNo": 1,
"isRequired": true
}
]
}
| Property | Type | Description |
|---|---|---|
| id | Number | Signature field identifier |
| x | Number | X coordinate position |
| y | Number | Y coordinate position |
| width | Number | Width of signature field |
| height | Number | Height of signature field |
| pageNo | Number | Page number for signature placement |
| isRequired | Boolean | Whether signature is required |
Mapping to Recipient Alignment
The mappings.signatures array is index-aligned with the recipient fields.
This means each signature mapping is assigned to a recipient based on its position (index) in the array.
How It Works
-
signatures[0]→ corresponds toemail_address[0],first_name[0],middle_name[0],last_name[0],receives_email_notifs[0],completed_email_notifs[0],sequence[0] -
signatures[1]→ corresponds toemail_address[1],first_name[1],middle_name[1],last_name[1],receives_email_notifs[1],completed_email_notifs[1],sequence[1]
Example
Signatures Mapping
{
"signatures": [
{
"id": "01KP2ZWQVWZ68QH8PZRK1720KN",
"x": 69,
"y": 182,
"width": 100,
"height": 50,
"pageNo": 1,
"isRequired": true
},
{
"id": "01KP2ZX7GVCHY5W05QW4Q9QEVS",
"x": 69,
"y": 267,
"width": 100,
"height": 50,
"pageNo": 1,
"isRequired": true
}
]
}
Recipients (Form Data)
email_address[0]: [email protected]
first_name[0]: John
middle_name[0]: A
last_name[0]: Doe
receives_email_notifs[0]: 1
completed_email_notifs[0]: 1
sequence[0]: 1
email_address[1]: [email protected]
first_name[1]: Jane
middle_name[1]: B
last_name[1]: Smith
receives_email_notifs[1]: 0
completed_email_notifs[1]: 1
sequence[1]: 1
Result
-
First signature (
signatures[0]) → assigned to user1 -
Second signature (
signatures[1]) → assigned to user2
Important Notes
-
The order must match between
signaturesand recipient fields. -
The number of signature mappings should match the number of recipients.
-
Misalignment may result in signatures being assigned to the wrong recipient.
Summary
Each signatures[i] is assigned to the recipient at index i.
Recipient Details (Indexed)
Recipients are specified using indexed fields. For multiple recipients, increment the index (e.g., [0], [1], [2]).
| Field | Type | Description |
|---|---|---|
| email_address[n] | String | Email address of recipient |
| first_name[n] | String | First name of recipient |
| middle_name[n] | String | Middle name of recipient |
| last_name[n] | String | Last name of recipient |
| receives_email_notifs[n] | Number | Whether recipient receives email notifications (1 = yes) |
| completed_email_notifs[n] | Number (0 or 1) | If set to 1, a completion notification email will be sent to the recipient when the document signing is completed. Set to 0 to disable. |
| sequence[n] | Number | Defines the signing order for recipients. If all recipients have the same sequence number (e.g., all set to 1), they can sign simultaneously. If sequence numbers are incrementing (1, 2, 3...), recipients must sign in that order, one after another. |
Example for two recipients:
-
email_address[0],first_name[0],middle_name[0],last_name[0],receives_email_notifs[0],completed_email_notifs[0],sequence[0] -
email_address[1],first_name[1],middle_name[1],last_name[1],receives_email_notifs[1],completed_email_notifs[1],sequence[1]
Variables Used
| Variable | Description |
|---|---|
{{host_url}} | Base URL for the API |
{USER-TOKEN} | Authentication token |
Post-Response Script
The post-response script automatically sets the project-uuid environment variable from the response for use in subsequent requests.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||