Send document for signature

post

https://sign-server.twala.io/api/v1/send

Send document to signatories.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

document_name

string

Set document name. If nothing is passed, server will automatically use the template name as the document name.

template_uuid

string

The template to be used.

document_invitations

json

An array of invitations specifying the email and full_name of the signatory and the corresponding role_uuid as required by the selected template.

audit_trail

json

The audit trail properties specifying which features are enabled.

carbon_copies

json

An array of carbon copies specifying the email and full_name of the recipient.

message

string

A message to be sent to all signatories of the document invite.

password

string

A password to protect the document.

custom_field_values

json

An array of field and values to be filled up for the selected template.

test

boolean

(Optional) Access the endpoint in test mode. Signature requests created in test mode are not legally binding and are watermarked as such.

ordered_signing

boolean

(Optional) Enable ordered signing

embedded_signing

boolean

(Optional) Enable embedded signing

Headers

Twala-Application-Uuid

string

The application UUID is globally unique to your account. It can be found in the API Access section of your application within the Twala Sign dashboard.

Twala-Application-Secret

string

The application secret is known only to your application and Twala Sign. It protects your resources by only granting access to authorized requestors.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200