Signature requests can be initiated with Submissions API. Submissions can contain one submitter if signed by a single party or multiple submitters if the document template form contains signatures and fields to be collected and filled by multiple parties. Initiate new submissions to request signatures for specified submitters via email or phone number.
List all submissions
The API endpoint provides the ability to retrieve a list of available submissions.
query Parameters
template_idThe template ID allows you to receive only the submissions created from that specific template.
statusFilter submissions by status.
qFilter submissions based on submitters name, email or phone partial match.
slugFilter submissions by unique slug.
template_folderFilter submissions by template folder name.
archivedReturns only archived submissions when true and only active submissions when false.
limitThe number of submissions to return. Default value is 10. Maximum value is 100.
afterThe unique identifier of the submission to start the list from. It allows you to receive only submissions with an ID greater than the specified value. Pass ID value from the pagination.next response to load the next batch of submissions.
beforeThe unique identifier of the submission that marks the end of the list. It allows you to receive only submissions with an ID less than the specified value.
List all submissions › Responses
OK
Create a submission
This API endpoint allows you to create signature requests (submissions) for a document template and send them to the specified submitters (signers).
Related Guides
Send documents for signature via API
Pre-fill PDF document form fields with API
Create a submission › Request Body
template_idThe unique identifier of the template. Document template forms can be created via the Web UI, PDF and DOCX API, or HTML API.
The list of submitters for the submission.
send_emailSet false to disable signature request emails sending.
send_smsSet true to send signature request via phone number and SMS.
orderPass 'random' to send signature request emails to all parties right away. The order is 'preserved' by default so the second party will receive a signature request email only after the document is signed by the first party.
completed_redirect_urlSpecify URL to redirect to after the submission completion.
bcc_completedSpecify BCC address to send signed documents to after the completion.
reply_toSpecify Reply-To address to use in the notification emails.
expire_atSpecify the expiration date and time after which the submission becomes unavailable for signature.
Create a submission › Responses
OK
idSubmitter unique ID number.
submission_idSubmission UUID.
uuidSubmitter UUID.
emailThe email address of the submitter.
slugUnique key to be used in the signing form URL.
statusThe status of signing request for the submitter.
An array of pre-filled values for the submission.
metadatasent_atThe date and time when the signing request was sent to the submitter.
opened_atThe date and time when the submitter opened the signing form.
completed_atThe date and time when the submitter completed the signing form.
declined_atThe date and time when the submitter declined the signing form.
created_atThe date and time when the submitter was created.
updated_atThe date and time when the submitter was last updated.
nameThe name of the submitter.
phoneThe phone number of the submitter.
external_idYour application-specific unique string key to identify this submitter within your app.
roleThe role of the submitter in the signing process.
embed_srcThe src URL value to embed the signing form or sign via a link.
Get a submission
The API endpoint provides the functionality to retrieve information about a submission.
path Parameters
idThe unique identifier of the submission.
Get a submission › Responses
OK
idSubmission unique ID number.
slugUnique slug of the submission.
sourceThe source of the submission.
submitters_orderThe order of submitters.
audit_log_urlAudit log file URL.
combined_document_urlCombined PDF file URL with documents and Audit Log.
created_atThe date and time when the submission was created.
updated_atThe date and time when the submission was last updated.
archived_atThe date and time when the submission was archived.
The list of submitters.
created_by_userAn array of completed or signed documents of the submission.
statusThe status of the submission.
metadataObject with custom metadata.
completed_atThe date and time when the submission was fully completed.
nameName of the document submission
Get submission documents
This endpoint returns a list of partially filled documents for a submission. If the submission has been completed, the final signed documents are returned.
path Parameters
idThe unique identifier of the submission.
Get submission documents › Responses
OK
idSubmission unique ID number.
Create submissions from emails
This API endpoint allows you to create submissions for a document template and send them to the specified email addresses. This is a simplified version of the POST /submissions API to be used with Zapier or other automation tools.
Create submissions from emails › Request Body
template_idThe unique identifier of the template.
emailsA comma-separated list of email addresses to send the submission to.
send_emailSet false to disable signature request emails sending.
Create submissions from emails › Responses
OK
idSubmitter unique ID number.
submission_idSubmission UUID.
uuidSubmitter UUID.
emailThe email address of the submitter.
slugUnique key to be used in the signing form URL.
statusThe status of signing request for the submitter.
An array of pre-filled values for the submission.
metadatasent_atThe date and time when the signing request was sent to the submitter.
opened_atThe date and time when the submitter opened the signing form.
completed_atThe date and time when the submitter completed the signing form.
declined_atThe date and time when the submitter declined the signing form.
created_atThe date and time when the submitter was created.
updated_atThe date and time when the submitter was last updated.
nameThe name of the submitter.
phoneThe phone number of the submitter.
external_idYour application-specific unique string key to identify this submitter within your app.
roleThe role of the submitter in the signing process.
embed_srcThe src URL value to embed the signing form or sign via a link.
Create a submission from PDF
The API endpoint provides the functionality to create one-off submission request from a PDF. Use {{Field Name;role=Signer1;type=date}} text tags to define fillable fields in the document. See https://www.sealroute.com/examples/fieldtags.pdf for more text tag formats. Or specify the exact pixel coordinates of the document fields using fields param.
Related Guides
Use embedded text field tags to create a fillable form
Create a submission from PDF › Request Body
The list of submitters for the submission.
nameName of the document submission.
send_emailSet false to disable signature request emails sending.
send_smsSet true to send signature request via phone number and SMS.
orderPass 'random' to send signature request emails to all parties right away. The order is 'preserved' by default so the second party will receive a signature request email only after the document is signed by the first party.
completed_redirect_urlSpecify URL to redirect to after the submission completion.
bcc_completedSpecify BCC address to send signed documents to after the completion.
reply_toSpecify Reply-To address to use in the notification emails.
expire_atSpecify the expiration date and time after which the submission becomes unavailable for signature.
template_idsAn optional array of template IDs to use in the submission along with the provided documents. This can be used to create multi-document submissions when some of the required documents exist within templates.
flattenRemove PDF form fields from the documents.
merge_documentsSet true to merge the documents into a single PDF file.
remove_tagsPass false to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.
Create a submission from PDF › Responses
OK
idSubmission unique ID number.
The list of submitters.
sourceThe source of the submission.
submitters_orderThe order of submitters.
statusThe status of the submission.
expire_atSpecify the expiration date and time after which the submission becomes unavailable for signature.
created_atThe date and time when the submission was created.
nameSubmission name.
The one-off submission document files.
List of fields to be filled in the one-off submission.
Create a submission from DOCX
The API endpoint provides functionality to create a one-off submission request from a DOCX file with dynamic content variables. Use [[variable_name]] text tags to define dynamic content variables in the document. See https://www.sealroute.com/examples/demo_template.docx for the specific text variable syntax, including dynamic content tables and list. You can also use the {{signature}} field syntax to define fillable fields, as in a PDF.
Related Guides
Use dynamic content variables in DOCX to create personalized documents
Create a submission from DOCX › Request Body
The list of submitters for the submission.
nameName of the document submission.
send_emailSet false to disable signature request emails sending.
send_smsSet true to send signature request via phone number and SMS.
variablesDynamic content variables object. Variable values can be strings, numbers, arrays, objects, or HTML content used to generate styled text, paragraphs, and tables in DOCX.
orderPass 'random' to send signature request emails to all parties right away. The order is 'preserved' by default so the second party will receive a signature request email only after the document is signed by the first party.
completed_redirect_urlSpecify URL to redirect to after the submission completion.
bcc_completedSpecify BCC address to send signed documents to after the completion.
reply_toSpecify Reply-To address to use in the notification emails.
expire_atSpecify the expiration date and time after which the submission becomes unavailable for signature.
template_idsAn optional array of template IDs to use in the submission along with the provided documents. This can be used to create multi-document submissions when some of the required documents exist within templates.
merge_documentsSet true to merge the documents into a single PDF file.
remove_tagsPass false to disable the removal of {{text}} tags from the PDF. This can be used along with transparent text tags for faster and more robust PDF processing.
Create a submission from DOCX › Responses
OK
idSubmission unique ID number.
The list of submitters.
sourceThe source of the submission.
submitters_orderThe order of submitters.
statusThe status of the submission.
expire_atSpecify the expiration date and time after which the submission becomes unavailable for signature.
created_atThe date and time when the submission was created.
nameSubmission name.
The one-off submission document files.
List of fields to be filled in the one-off submission.
Create a submission from HTML
This API endpoint allows you to create a one-off submission request document using the provided HTML content, with special field tags rendered as a fillable and signable form.
Related Guides
Create PDF document fillable form with HTML
Create a submission from HTML › Request Body
The list of documents built from HTML. Can be used to create a submission with multiple documents.
The list of submitters for the submission.
nameName of the document submission
send_emailSet false to disable signature request emails sending.
send_smsSet true to send signature request via phone number and SMS.
orderPass 'random' to send signature request emails to all parties right away. The order is 'preserved' by default so the second party will receive a signature request email only after the document is signed by the first party.
completed_redirect_urlSpecify URL to redirect to after the submission completion.
bcc_completedSpecify BCC address to send signed documents to after the completion.
reply_toSpecify Reply-To address to use in the notification emails.
expire_atSpecify the expiration date and time after which the submission becomes unavailable for signature.
template_idsAn optional array of template IDs to use in the submission along with the provided documents. This can be used to create multi-document submissions when some of the required documents exist within templates.
merge_documentsSet true to merge the documents into a single PDF file.
Create a submission from HTML › Responses
OK
idSubmission unique ID number.
The list of submitters.
sourceThe source of the submission.
submitters_orderThe order of submitters.
statusThe status of the submission.
expire_atSpecify the expiration date and time after which the submission becomes unavailable for signature.
created_atThe date and time when the submission was created.
nameSubmission name.
The one-off submission document files.
List of fields to be filled in the one-off submission.