v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Document

Add a Document to a Signature Request

Add a Document to a given Signature Request.

Limits: a maximum of 50 Documents can be added per Signature Request.

Related guide: Document

ℹ️ This endpoint accepts two request body formats — pick the one that matches your use case:

  • 📁 multipart/form-data — upload a binary file (PDF, DOCX, JPEG, JPG, PNG).
  • 📝 application/json — reference an existing Electronic Seal Document by ID.

🔓 Endpoint access

  • Environments: production, sandbox
  • API key scopes: organization, workspace
  • Plans: plus, pro, scale
  • Add-ons (for production access): none
post/signature_requests/{signatureRequestId}/documents

Path parameters

signatureRequestIdstring uuid required

The unique identifier for a resource.

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

Signature Request Id

Request body

electronic_seal_document_idstring uuid required

Id of the Electronic Seal Document. The Electronic Seal must be done to use its Electronic Seal Document.

namestring nullable
nature'attachment' | 'signable_document' required
insert_after_idstring uuid nullable

Insert just after the position of the specified Document id.

parse_anchorsboolean nullable

If true, the system will parse the document exclusively for Signature-type Smart Anchors and automatically generate the required fields.

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

{
  "electronic_seal_document_id": "672a5a0b-ac65-407e-9da9-d34402bae974",
  "name": "file1",
  "nature": "signable_document",
  "insert_after_id": "8b6ed2f3-244f-487a-baa1-bbe4f51c8744",
  "parse_anchors": true,
  "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

Created

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"
}