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 Approver API

Person responsible for validating a Signature Request.

YouSign Approver 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 Approver. 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 5 operations across 3 paths, and defines 22 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.

5 operations 3 paths 22 schemas 1 DELETE1 GET1 PATCH2 POST

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 Approver API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 5

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

Approver 5

Person responsible for validating a Signature Request.

POST
/signature_requests/{signatureRequestId}/approvers
Create a new Approver
post-signature_requests-signatureRequestId-approvers 1 param body → 201400401403404405415429
DELETE
/signature_requests/{signatureRequestId}/approvers/{approverId}
Delete an Approver
delete-signature_requests-signatureRequestId-approvers-approverId 2 params → 204400401403404405429500
GET
/signature_requests/{signatureRequestId}/approvers/{approverId}
Get an Approver
get-signature_requests-signatureRequestId-approvers-approverId 2 params → 200401403404405429500
PATCH
/signature_requests/{signatureRequestId}/approvers/{approverId}
Update an Approver
patch-signature_requests-signatureRequestId-approvers-approverId 2 params body → 200400401403404405415429
POST
/signature_requests/{signatureRequestId}/approvers/{approverId}/send_reminder
Send manual reminder to an Approver
post-signature_requests-signatureRequestId-approvers-approverId-send_reminder 2 params → 201400401403404405429500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are Approver (9 properties), New_Approver_From_Scratch_info (5 properties), UpdateApprover_info (5 properties), UpdateApprover (5 properties). Each schema is shown below with its type and property counts.

New_Approver_From_Scratch
object
Create a new Approver from scratch.
1 property 1 required
InternalServerError
object
2 properties 2 required
New_Approver_From_Existing_Signer
object
Create a new Approver from an existing Signer.
1 property 1 required
CreateApprover
object
4 properties
TooManyRequestsResponse
object
1 property 1 required
Approver
object
Approver
9 properties 7 required
ExcludedDocuments
array
List of Document IDs not visible to this Recipient. When omitted, the Recipient can see all Documents. Only available when the documentvisibility feature is en…
UnsupportedMediaTypeResponse
object
2 properties 2 required
New_Approver_From_Existing_User
object
Create a new Approver from an existing User.
1 property 1 required
New_Approver_From_Scratch_info
object
5 properties 4 required
UpdateApprover
object
5 properties
MethodNotAllowed
object
1 property 1 required
Locale
string
Locale settings used for communication.
NotFoundResponse
object
2 properties 2 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.
UpdateApprover_info
object
5 properties
New_Approver_From_Existing_Contact
object
Create a new Approver from an existing Contact.
1 property 1 required
CustomText
object
Custom Text
4 properties 4 required
Approver_info
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-approver-api-openapi.yml Raw ↑

Other APIs YouSign publishes across the network.

YouSign Applicant 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
YouSign Document Analysis API