Send Document
Send Document
Twala’s API V1.0 only allows sending signature requests using pre-created templates with custom fields created on your Twala Sign dashboard.
Templates allow you to request a signature without the need to manually prepare the document every time you send it. You only need to upload the document, set the fields once, and use it every time to request a signature.
By using a template, you can specify what fields your signers need to fill.
Field Types
| Standard Fields | Auto-fill Fields |
|---|---|
| - Signature | - Date Signed |
| - Text | |
| - Checkbox | - Name |
| - Radio Buttons | - Initials |
Apart from the auto-fill fields above, you can also pre-fill the fields with custom data for your signers using custom fields.
In this request, two signers will receive an email containing the link to the document that they need to fill out and sign.
To send a signature request via API, use the send document for signature endpoint. See below for a sample format of the request body.
Request Parameters
| Parameter | Sample Value | Required | Description |
|---|---|---|---|
document_name | Test Document | No | Set document name. If nothing is passed, the server will automatically use the template name as the document name. |
template_uuid | 5ed8f529-c7c8-4869-9a7a-abc416c347b0 | Yes | The template to be used. |
document_invitations | [{"role_uuid":"e7dde060-38fa-11ec-be15-9f4f71ca2bfa","email":"[email protected]","full_name":"Test User","order": 0}] | Yes | 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 | {"is_enabled":true,"id":true,"email":true,"mobile":true,"author":true,"uuid":true} | Yes | The audit trail properties specifying which features are enabled. |
carbon_copies | [{"email":"[email protected]","full_name":"Test User"}] | No | An array of carbon copies specifying the email and full name of the recipient. |
message | Please sign this document | No | A message to be sent to all signatories of the document invite. |
password | SecurePassword123! | No | A password to protect the document. |
custom_field_values | [{"annotation_id": "d1e3f657-37f6-766f-4477-77bb5def3754", "value": "Manila"}] | No | An array of field and values to be filled up for the selected template. |
test | true | No | Access the endpoint in test mode. Signature requests created in test mode are not legally binding and are watermarked as such. Default is false. |
Retrieve Documents
You can retrieve all your API documents by sending a GET request to the get all documents endpoint.
Check Document Status
To get the current status of the document, send a GET request to the check document status endpoint.
Cancel Document
Cancel the document signing process by calling the cancel document endpoint. Note that you can only cancel a document if it is in the "For Signature" status.
Download Document
Once a document has been completed, you can call the download document endpoint to download a copy of the document.
Updated 3 days ago