Documents

Upload and manage PDF/DOCX documents for digital signing.

Endpoints

GET/api/v1/documents

List documents

Required permissions:documents:read

client.documents.get()

POST/api/v1/documents

Upload document — Upload a PDF or DOCX via multipart/form-data. Max 50 MB.

Required permissions:documents:write

client.documents.post(body)

POST/api/v1/documents/import

Import document bundle — Imports a .formalingo-doc bundle as a new draft document. Integrations, submissions, signers, responses, deliveries, and automation actions are excluded.

Required permissions:documents:write

client.documents.import.post(body)

GET/api/v1/documents/{id}

Get document

Required permissions:documents:read

client.documents.byId("ID").get()

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

Export document bundle — Exports the current editable document as a .formalingo-doc bundle with fields, signer roles, settings, source content, and automation conditions.

Required permissions:documents:read

client.documents.byId("ID").export.get()

PUT/api/v1/documents/{id}

Update document

Required permissions:documents:write

client.documents.byId("ID").put(body)

DELETE/api/v1/documents/{id}

Delete document

Required permissions:documents:delete

client.documents.byId("ID").delete()

POST/api/v1/documents/{id}/publish

Publish a document — Publishes the current draft as the next document revision. Requires user-backed auth context in addition to the documents:publish permission.

Required permissions:documents:writedocuments:publish

client.documents.byId("ID").publish.post(body)

This page is auto-generated from the OpenAPI spec. Run npm run docs:generate to update.

Documents

Documents

Endpoints

On this page