v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB

Document

Update a Document

Updates a given Document. Any parameters not provided are left unchanged.

patch/signature_requests/{signatureRequestId}/documents/{documentId}

Path parameters

signatureRequestIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Signature Request Id

documentIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Document Id

Request body

nature'attachment' | 'signable_document'

Files in JPEG, JPG, and PNG format can only be of attachment nature.

insert_after_idstring uuid nullable

Insert just after the position of the specified document id

passwordstring

The password required to unlock the document if it is protected

namestring

The new name to be assigned to the document. This value should contain any characters except "", "/" and can't start and finish with a space.

excluded_approversstring[]

List of Approver IDs who cannot see this Document. When omitted, all Approvers can see it (default). Only available when the document_visibility feature is enabled on the organization.

excluded_signersstring[]

List of Signer IDs who cannot see this Document. When omitted, all Signers can see it (default). Requires the document_visibility feature to be enabled on the organization.

Example request

{
  "insert_after_id": "8b6ed2f3-244f-487a-baa1-bbe4f51c8744",
  "password": "MyPa$$word",
  "name": "file1",
  "initials": {
    "y": 10
  },
  "excluded_approvers": [
    "550e8400-e29b-41d4-a716-446655440000",
    "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  ],
  "excluded_signers": [
    "550e8400-e29b-41d4-a716-446655440000",
    "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  ]
}

Response

idstring uuid required

filenamestring required

nature'attachment' | 'signable_document' required

content_typestring required

sha256string required

Sha256 checksum

is_protectedboolean required

is_signedboolean required

created_atstring date-time required

total_pagesinteger nullable required

Number of pages for signable document

is_lockedboolean required

If protected by password and not yet unlocked

total_anchorsinteger required

Number of parsed anchors from the document.

excluded_approversstring[] required

List of Approver IDs who cannot see this Document.

excluded_signersstring[] required

List of Signer IDs who cannot see this Document.

Example response

{
  "id": "89120884-d29a-4b1a-ac7b-a9e73a872796",
  "content_type": "application/pdf",
  "created_at": "2024-01-18T22:59:00Z"
}