Documents

GET /v1/documents

List Documents

Query

• status string | null
• folder string (uuid) | null
• q string (max length 200) | null
• sort string default "created"
• batch string (uuid) | null . A bulk send id: list only its member documents. Without it, members of bulk sends are hidden (the batch is the first-class object, BS-4).
• limit integer (>= 1, <= 200) default 50
• offset integer (>= 0) default 0

Responses

• 200 DocumentPage
• 4xx 5xx application/problem+json; see the error reference.

POST /v1/documents

Create Document

Request body (application/json, required)

Responses

• 201 DocumentDraftOut
• 4xx 5xx application/problem+json; see the error reference.

GET /v1/documents/{doc_id}

Get Document

Path

• doc_id string

Responses

• 200 DocumentOut | DocumentAwaitingUpload
• 4xx 5xx application/problem+json; see the error reference.

PATCH /v1/documents/{doc_id}

Patch Document

Path

• doc_id string

Request body (application/json, required)

Responses

• 200 DocumentOut
• 4xx 5xx application/problem+json; see the error reference.

PUT /v1/documents/{doc_id}/content

Upload Document Content

Direct-upload fallback for backends without presigned PUT.

Path

• doc_id string

Responses

• 204 no body
• 4xx 5xx application/problem+json; see the error reference.

GET /v1/documents/{doc_id}/download

Download Document

Path

• doc_id string

Query

• variant string default "signed"

Responses

• 200 any
• 4xx 5xx application/problem+json; see the error reference.

POST /v1/documents/{doc_id}/duplicate

Duplicate Document

T-5 "use as new" (D54): a fresh draft from the original PDF with the same recipients, fields, and display preferences. No signing links exist until it is sent; nothing is emailed.

Path

• doc_id string

Request body (application/json)

Type: DuplicateDocumentIn | null

Responses

• 201 DocumentOut
• 4xx 5xx application/problem+json; see the error reference.

GET /v1/documents/{doc_id}/events

Document Events

Path

• doc_id string

Query

• after_seq integer (>= 0) default 0

Responses

• 200 array of EventOut
• 4xx 5xx application/problem+json; see the error reference.

PUT /v1/documents/{doc_id}/fields

Put Fields

Path

• doc_id string

Request body (application/json, required)

Type: array of FieldSpec

Responses

• 200 array of FieldOut
• 4xx 5xx application/problem+json; see the error reference.

POST /v1/documents/{doc_id}/finalize

Finalize Document

Path

• doc_id string

Responses

• 200 DocumentOut
• 4xx 5xx application/problem+json; see the error reference.

PUT /v1/documents/{doc_id}/recipients

Put Recipients

Path

• doc_id string

Request body (application/json, required)

Type: array of RecipientSpec

Responses

• 200 array of RecipientOut
• 4xx 5xx application/problem+json; see the error reference.

POST /v1/documents/{doc_id}/send

Send Document

Path

• doc_id string

Request body (application/json)

Type: SendReq | null

Responses

• 202 SendOut
• 4xx 5xx application/problem+json; see the error reference.

POST /v1/documents/{doc_id}/void

Void Document

Path

• doc_id string

Request body (application/json, required)

Responses

• 202 VoidOut
• 4xx 5xx application/problem+json; see the error reference.