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 Consent Request API

Process of asking signers to consent to specific needs during the signature process.

YouSign Signer Consent 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 Consent 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 6 operations across 3 paths, and defines 15 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.

6 operations 3 paths 15 schemas 2 DELETE1 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 Consent Request API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 6

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

Signer Consent Request 6

Process of asking signers to consent to specific needs during the signature process.

GET
/signature_requests/{signatureRequestId}/consent_requests
List Signer Consent Requests of the Signature Request
get-signature_requests-signatureRequestId-signer_consent_requests 1 param → 200401403404405429500
POST
/signature_requests/{signatureRequestId}/consent_requests
Add Signer Consent Request to a Signature Request
post-signature_requests-signatureRequestId-consent_requests 1 param body → 201400401403404405415429
DELETE
/signature_requests/{signatureRequestId}/consent_requests/{consentRequestId}
Delete a Signer Consent Request
delete-signature_requests-signatureRequestId-consent_requests-consentRequestId 2 params → 204400401403404405429500
PATCH
/signature_requests/{signatureRequestId}/consent_requests/{consentRequestId}
Update a Signer Consent Request
patch-signature_requests-signatureRequestId-consent_requests-consentRequestId 2 params body → 200400401403404405429500
DELETE
/signature_requests/{signatureRequestId}/consent_requests/{consentRequestId}/signers/{signerId}
Remove a Signer from a given Signer Consent Request
delete-signature_requests-signatureRequestId-consent_requests-consentRequestId-signers-signerId 3 params → 204400401403404405429500
PUT
/signature_requests/{signatureRequestId}/consent_requests/{consentRequestId}/signers/{signerId}
Adds a Signer to a given Signer Consent Request
put-signature_requests-signatureRequestId-consent_requests-consentRequestId-signers-signerId 3 params → 204400401403404405429500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are CreateSignerConsentRequest (6 properties), SignerConsentRequest (6 properties), UpdateSignerConsentRequest (4 properties), UnauthorizedResponse (2 properties). Each schema is shown below with its type and property counts.

InternalServerError
object
2 properties 2 required
SignerConsentRequest_settings
object
Settings relative to Signer Consent Request's type
1 property 1 required
TooManyRequestsResponse
object
1 property 1 required
SignerConsentRequest
object
Signer Consent Request attached to a Signature Request
6 properties 6 required
get_signature_requests_signatureRequestId_signer_consent_requests_200_response
object
1 property
UnsupportedMediaTypeResponse
object
2 properties 2 required
MethodNotAllowed
object
1 property 1 required
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.
CreateSignerConsentRequest_settings
object
Settings relative to Signer Consent Request's type
1 property 1 required
CreateSignerConsentRequest
object
6 properties 4 required
UpdateSignerConsentRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yousign-signer-consent-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