Send Document
Send Document
Twala’s API V1.0 only allows sending of signature requests using pre-created templates with custom fields created on your Twala Sign dashboard.
Templates allow you to request for 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 for a signature.
By using a template, you can specify what fields your signers need to fill.
| Standard Fields | Auto-fill Fields |
|---|---|
| Signature Text Checkbox Radio Buttons | Date Signed Name Initials |
Apart from the auto-fill fields above, you can also pre-fill the fields with custom data for your signers with the custom field fields.
In this request, two signers will receive an email containing the link to the document that the customers need to fill out and sign.
To send a signature request via API, use send document for signature endpoint. See below for a sample format of the request body.
| Parameter | Sample Value | Required | Description |
|---|---|---|---|
| document_name | Test Document | No | Set document name. If nothing is passed, 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"}, {"annotation_id": "e621f236-8f48-1688-c8e5-8c16a1d76bae", "value": "25"}, {"annotation_id": "1793e30a-6772-8dc0-234e-a4ad6669f1e7", "value": "Male"}] | 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 get all documents endpoint.
Check Document Status
To get the current status of the document, send a GET request to check document status endpoint.
Cancel Document
Cancel the document signing process by calling cancel document endpoint, note that you can only cancel a document if it is on "For Signature" status.
Download Document
Once a document has been completed, you can call download document endpoint to download a copy of the document.
Updated 4 months ago