How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YouSign Document API

Document that is attached to the Signature Request.

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 Documents. 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.2.0, at version 3.0.

Requests are made against 2 base URLs: https://api-sandbox.yousign.app/v3, https://api.yousign.app/v3.

8 operations 5 paths 19 schemas 1 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0
Base URL
https://api.yousign.com/v3
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

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.

GET
/signature_requests/{signatureRequestId}/documents
List Signature Request's Documents
get-signature_requests-signatureRequestId-documents 2 params → 200400401403404405429500
POST
/signature_requests/{signatureRequestId}/documents
Add a Document to a Signature Request
post-signature_requests-signatureRequestId-documents 1 param body → 201400401403404405415429
GET
/signature_requests/{signatureRequestId}/documents/download
Download Signature Request's Documents
get-signature_requests-signatureRequestId-documents-download 3 params → 200400401404405429500
DELETE
/signature_requests/{signatureRequestId}/documents/{documentId}
Delete a Document
delete-signature_requests-signatureRequestId-documents-documentId 2 params → 204400401403404405429500
GET
/signature_requests/{signatureRequestId}/documents/{documentId}
Get a Document
get-signature_requests-signatureRequestId-documents-documentId 2 params → 200401403404405429500
PATCH
/signature_requests/{signatureRequestId}/documents/{documentId}
Update a Document
patch-signature_requests-signatureRequestId-documents-documentId 2 params body → 200400401403404405415429
GET
/signature_requests/{signatureRequestId}/documents/{documentId}/download
Download a single Signature Request's Document
get-signature_requests-signatureRequestId-documents-documents-id-download 2 params → 200400401403404405429500
POST
/signature_requests/{signatureRequestId}/documents/{documentId}/replace
Replace a Document in a Signature Request
post-signature_requests-signatureRequestId-documents-documentId-replace 2 params body → 201400401403404405415429

Schemas 19

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.

CreateDocumentFromMultipart
object
9 properties 2 required
NotFoundResponse
object
2 properties 2 required
UnauthorizedResponse
object
2 properties 2 required
UpdateDocument
object
7 properties
Document
object
Document to attach to a Signature Request
14 properties 14 required
TooManyRequestsResponse
object
1 property 1 required
InitialsArea
object
2 properties 2 required
UUID
string
The unique identifier for a resource.
post_signature_requests_signatureRequestId_documents_documentId_replace_request
object
2 properties 1 required
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…
CreateDocumentFromJson
object
7 properties 2 required
ForbiddenResponse
object
2 properties 2 required
InternalServerError
object
2 properties 2 required
Document_initials
objectnull
3 properties 3 required
Document_initials_per_page_inner
object
2 properties 2 required
BadRequestResponse
object
2 properties 2 required
UnsupportedMediaTypeResponse
object
2 properties 2 required
DocumentExcludedSigners
array
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…
MethodNotAllowed
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-document-api-openapi.yml Raw ↑

Other APIs YouSign publishes across the network.

YouSign Applicant API
YouSign Approver API
YouSign Archive API
YouSign Audit Trail API
YouSign Bank Account Lookup Verification API
YouSign Bank Account Verification API
YouSign Company Verification API
YouSign Consumption API
YouSign Contact API
YouSign Custom Experience API
YouSign Custom Property API
YouSign Deprecated API
Where this information came from

This is an independent, third-party profile of YouSign Document API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.