YouSign Document API is one of 38 APIs that YouSign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Document. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a changelog, rate-limit docs, and 1 JSON Schema.
This API exposes
8 operations
across 5 paths,
and defines 19 schemas.
It is described by OpenAPI 3.0.0, at version 3.0.
Requests are made against 2 base URLs: https://api-sandbox.yousign.app/v3, https://api.yousign.app/v3.
8 operations5 paths19 schemas1 DELETE4 GET1 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
YouSign Document API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 8
Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Document 8
Document that is attached to the Signature Request.
The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Document (14 properties), CreateDocumentFromMultipart (9 properties), CreateDocumentFromJson (7 properties), UpdateDocument (7 properties). Each schema is shown below with its type and property counts.
DocumentExcludedApprovers
array
List of Approver IDs who cannot see this Document. When omitted, all Approvers can see it (default). Only available when the documentvisibility feature is enab…
List of Signer IDs who cannot see this Document. When omitted, all Signers can see it (default). Requires the documentvisibility feature to be enabled on the o…
Specification
The full machine-readable OpenAPI contract behind this narrative.
