Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YouSign Signer Document Request API

Process of asking signers to upload specific documents during the signature process.

YouSign Signer Document Request 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 Signer Document Request. 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 9 operations across 5 paths, and defines 16 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.

9 operations 5 paths 16 schemas 3 DELETE3 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

YouSign Signer Document Request API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 3 DELETE, 3 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Signer Document Request 9

Process of asking signers to upload specific documents during the signature process.

GET
/signature_requests/{signatureRequestId}/document_requests
List Signer Document Requests of the Signature Request
get-signature_requests-signatureRequestId-signer_document_requests 1 param → 200401403404405429500
POST
/signature_requests/{signatureRequestId}/document_requests
Add Signer Document Request to a Signature Request
post-signature_requests-signatureRequestId-document_requests 1 param body → 201400401403404405415429
DELETE
/signature_requests/{signatureRequestId}/document_requests/{documentRequestId}
Delete a Signer Document Request
delete-signature_requests-signatureRequestId-document_requests-documentRequestId 2 params → 204400401403404405429500
PATCH
/signature_requests/{signatureRequestId}/document_requests/{documentRequestId}
Update a Signer Document Request
patch-signature_requests-id-document_requests-id 2 params body → 200400401403404405415429
DELETE
/signature_requests/{signatureRequestId}/document_requests/{documentRequestId}/signers/{signerId}
Remove a Signer to a given Signer Document Request
delete-signature_requests-signatureRequestId-document_requests-documentRequestId-signers-signerId 3 params → 204400401403404405429500
PUT
/signature_requests/{signatureRequestId}/document_requests/{documentRequestId}/signers/{signerId}
Adds a Signer to a given Signer Document Request
put-signature_requests-signatureRequestId-document_requests-documentRequestId-signers-signerId 3 params → 200400401403404405429500
DELETE
/signature_requests/{signatureRequestId}/signers/{signerId}/documents
Delete the Documents uploaded by a Signer
delete-signature_requests-signatureRequestId-signers-signerId-documents 2 params → 204400401403404405429500
GET
/signature_requests/{signatureRequestId}/signers/{signerId}/documents
List the Signer Documents of a Signer
get-signature_requests-signatureRequestId-signers-signerId-documents 2 params → 200400401403404405429500
GET
/signature_requests/{signatureRequestId}/signers/{signerId}/documents/{signerDocumentId}/download
Download a Signer Document
get-signature_requests-signatureRequestId-signers-signerId-documents-signerDocumentId 3 params → 200400401403404405429500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are SignerDocumentRequest (4 properties), CreateSignerDocumentRequest (3 properties), SignerDocument (3 properties), UpdateSignerDocumentRequest (2 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
get_signature_requests_signatureRequestId_signers_signerId_documents_200_response
object
2 properties
TooManyRequestsResponse
object
1 property 1 required
CreateSignerDocumentRequest
object
3 properties 3 required
UnsupportedMediaTypeResponse
object
2 properties 2 required
get_signature_requests_signatureRequestId_signer_document_requests_200_response
object
1 property
MethodNotAllowed
object
1 property 1 required
NotFoundResponse
object
2 properties 2 required
SignerDocumentRequest
object
Signer Document Request attached to a Signature Request
4 properties 4 required
BadRequestResponse
object
2 properties 2 required
ForbiddenResponse
object
2 properties 2 required
UnauthorizedResponse
object
2 properties 2 required
UUID
string
The unique identifier for a resource.
SignerDocument
object
Signer Document
3 properties 3 required
Pagination
object
Metadata about the response.
1 property 1 required
UpdateSignerDocumentRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-signer-document-request-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