Skip to main content
Formalingo
Sign in
API Reference

Submissions

Create signing submissions and manage signers with pre-fill support.

Submissions

Create signing submissions and manage signers with pre-fill support.

Endpoints

GET/api/v1/documents/{id}/submissions

List submissions

Required scope:read:submissions
client.documents.byId("ID").submissions.get()
POST/api/v1/documents/{id}/submissions

Create submission — Creates a signing submission with optional pre-fill data.

Required scope:write:submissions
client.documents.byId("ID").submissions.post(body)
DELETE/api/v1/documents/{id}/submissions/{sid}

Delete submission

Required scope:write:submissions
client.documents.byId("ID").submissions.bySid("SID").delete()
GET/api/v1/documents/{id}/submissions/{sid}/signers

List signers

Required scope:read:submissions
client.documents.byId("ID").submissions.bySid("SID").signers.get()
PUT/api/v1/documents/{id}/submissions/{sid}/signers/{signerId}

Update signer

Required scope:write:submissions
client.documents.byId("ID").submissions.bySid("SID").signers.bySignerId("SIGNERID").put(body)
DELETE/api/v1/documents/{id}/submissions/{sid}/signers/{signerId}

Delete signer

Required scope:write:submissions
client.documents.byId("ID").submissions.bySid("SID").signers.bySignerId("SIGNERID").delete()
GET/api/v1/documents/{id}/submissions/{sid}/pdf

Download 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.

Required scope:read:submissions
client.documents.byId("ID").submissions.bySid("SID").pdf.get()
GET/api/v1/documents/{id}/submissions/{sid}/signers/{signerId}/responses

List signer responses — Returns all saved responses for a signer.

Required scope:read:submissions
client.documents.byId("ID").submissions.bySid("SID").signers.bySignerId("SIGNERID").responses.get()
PATCH/api/v1/documents/{id}/submissions/{sid}/signers/{signerId}/responses

Update signer responses — Update field values for a signer. Rejected if the field’s assigned signer has completed signing.

Required scope:write:submissions
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.

On this page

SubmissionsEndpoints