There are two main ways to automate the transmission of e-signature documents using our APIs.
1. Create new document and send
By combining multiple APIs and executing them in sequence, it is possible to automate everything from document creation to sending.
In addition, if users want to set up items manually, or if users want to preview the document before sending, it is possible to add some manual steps to the flow.
1.1 Automating the entire workflow
1.1.1 Retrieve access token
POST /oauth/token
1.1.2 Create new document
POST /api/v1/documents/new
Adding parties and document details will take place during this step.
1.1.3. Add field components
POST /api/v1/components/new
Each signer (party) must have at least one field component setup.
1.1.4 Prepare document for send
POST /api/v1/documents/{id}/annotateCalling this after all fields are added will update the document to a status where it is ready to be sent for signatures.
1.1.5 Send document
POST /api/v1/documents/send
Parties will receive signature request emails immediately after this is executed.
1.2 Manual operation after new document is created
1.2.1 Retrieve access token
POST /oauth/token
1.2.2 Create new document
POST /api/v1/documents/new
Adding parties and document details will take place during this step.
1.2.3 Retrieve URL to field component setup page
GET /api/v1/documents/{id}/builderRetrieves the URL to the field component setup page.
The returned URL will have a token, allowing the user to access the field component setup page without having to manually login.
1.2.4 Manually setup field components (application)
Access the field component setup page using the URL obtained in step 3 and manually add field components.
One or more fields are required for each signer.
1.2.5 Preview document (application)
Preview and double check the document
The "Back" button will redirect users to the previous page allowing users to make any necessary changes.
1.2.6 Send document (application)
Parties will receive signature request emails immediately after the "Send" button is clicked.
1.3 Manual operation after field components are added
1.3.1 Retrieve access token
POST /oauth/token
1.3.2 Create new document
POST /api/v1/documents/new
Adding parties and document details will take place during this step.
1.3.3. Add field components
POST /api/v1/components/new
Each signer (party) must have at least one field component setup.
1.3.4 Prepare document for send
POST /api/v1/documents/{id}/annotateCalling this after all fields are added will update the document to a status where it is ready to be previewed.
1.3.5 Retrieve URL to document preview page
GET /api/v1/documents/{id}/previewRetrieves the URL to the document preview page.
The returned URL will have a token, allowing the user to access the document preview page without having to manually login.
1.3.6 Preview document (application)
Access the document preview page using the URL obtained in step 4 and double check the document.
The "Back" button will redirect users to the previous page allowing users to make any necessary changes.
1.3.7 Send document (application)
Parties will receive signature request emails immediately after the "Send" button is clicked.
2. Launch existing template and send
Creating templates in advance will allow users to easily launch the templates and send documents via API.
2.1 Retrieve access token
POST /oauth/token
2.2 Launch template and send
POST /api/v1/templates/{id}/launchAdding parties and document details will take place during this step.
This step consists of the template launching process as well as the document sending process.
Parties will receive signature request emails immediately after this step is executed.
Read More
For new inquiries about the API, please contact [email protected].