API Reference
Status PageRoadmapTestimoniesShare feedback

Add a Document to a Signature Request

post
https://api-sandbox.yousign.app/v3/signature_requests//documents

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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Signature Request Id

Body Params

Sending file with metadata

uuid
required

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

string | null
string
enum
required
Allowed:
uuid | null

Insert just after the position of the specified Document id.

boolean | null
Defaults to false

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

excluded_approvers
array of uuids

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_approvers
excluded_signers
array of uuids

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.

excluded_signers
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 17 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 17 days ago