API Reference
Status PageRoadmapTestimoniesShare feedback
  1. Settings & Administration
  2. Deprecated

[DEPRECATED] Upload a Document

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

Deprecated endpoint, do not use.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Upload a Document

file
required

Binary file. Accepted formats: PDF, DOCX, JPEG, JPG and PNG. All files are converted to PDF upon upload.

string
enum
required

Can take two values: signable_document or attachment. Files in JPEG, JPG, and PNG format can only be of attachment nature.

Allowed:
uuid | null

Insert just after the position of the specified document id.

string
string
length between 1 and 128
^(?!\s)[^\/\\]+(?<!\s)$

The document name. If not set, will use the uploaded document name. This value should contain any characters except "", "/" and can't start and finish with a space.

initials
object | null
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.

boolean | null
Defaults to false

If true, flattens PDF form fields, removing their interactivity/annotations before the document is processed.

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
Responses

Updated 3 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago