Submissions
Create signing submissions and manage signers with pre-fill support.
Submissions
Create signing submissions and manage signers with pre-fill support.
Endpoints
Phone normalization
Phone inputs accept up to 80 characters.
- International input may include spaces, parentheses, and hyphens, but must include
+. - National input uses the workspace default phone country.
- Successful creates and edits return and store E.164, for example
+12025550100. - Invalid phone input returns
details.field,details.code, and an optional import row or signer index. - Existing rows are normalized only when used; they are not bulk rewritten.
Validation failures always return { success: false, error }; phone failures additionally include optional details with field, code, and an import/bulk row or signer index when applicable.
/api/v1/documents/{id}/submissionsList submissions
client.documents.byId("ID").submissions.get()/api/v1/documents/{id}/submissionsCreate submission — Creates a signing submission with optional pre-fill data. Notifications are suppressed by default; also requires submissions:send_notifications when notifications are explicitly enabled. Conditional: submissions:send_notifications.
createDocumentSubmission(client, "ID", body, "YOUR_STABLE_IDEMPOTENCY_KEY")/api/v1/documents/{id}/submissions/{sid}Get submission status
client.documents.byId("ID").submissions.bySid("SID").get()/api/v1/documents/{id}/submissions/{sid}Delete submission
client.documents.byId("ID").submissions.bySid("SID").delete()/api/v1/documents/{id}/submissions/{sid}/signersList signers
client.documents.byId("ID").submissions.bySid("SID").signers.get()/api/v1/documents/{id}/submissions/{sid}/signers/{signerId}Update signer
client.documents.byId("ID").submissions.bySid("SID").signers.bySignerId("SIGNERID").put(body)/api/v1/documents/{id}/submissions/{sid}/signers/{signerId}Delete signer
client.documents.byId("ID").submissions.bySid("SID").signers.bySignerId("SIGNERID").delete()/api/v1/documents/{id}/submissions/{sid}/pdfDownload signed PDF — Returns a short-lived (5-minute) presigned download URL for the completed signed PDF. Returns 404 if the submission is not yet completed or the PDF is still generating.
client.documents.byId("ID").submissions.bySid("SID").pdf.get()/api/v1/documents/{id}/submissions/{sid}/signers/{signerId}/responsesList signer responses — Returns all saved responses for a signer.
client.documents.byId("ID").submissions.bySid("SID").signers.bySignerId("SIGNERID").responses.get()/api/v1/documents/{id}/submissions/{sid}/signers/{signerId}/responsesUpdate signer responses — Update field values for a signer. Rejected if the field’s assigned signer has completed signing.
client.documents.byId("ID").submissions.bySid("SID").signers.bySignerId("SIGNERID").responses.get()This page is auto-generated from the OpenAPI spec. Run npm run docs:generate to update.