YouSign Signer 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. 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
11 operations
across 8 paths,
and defines 63 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.
11 operations8 paths63 schemas1 DELETE3 GET1 PATCH6 POST
Metadata
The identity and technical contract details declared by the specification.
YouSign Signer API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 11
Across 8 paths, the API surfaces 11 operations — 1 DELETE, 3 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are Signer (20 properties), FieldText (18 properties), New_Signer_From_Existing_Contact (14 properties), New_Signer_From_Existing_User (14 properties). Each schema is shown below with its type and property counts.
Signer_redirect_urls
object
3 properties3 required
HumanName
string
InternalServerError
object
2 properties2 required
New_Signer_From_Existing_User
object
Create a new signer from an existing user
14 properties2 required
SignerDeliveryMode
string
Override the delivery mode of the Signature Request for this Signer
Text_2
object
14 properties8 required
FieldRadioButtonGroup
object
8 properties8 required
FieldCheckbox
object
11 properties10 required
New_Signer_From_Scratch_custom_text
object
4 properties
TooManyRequestsResponse
object
1 property1 required
EmailNotification
object
1 property1 required
SmsNotification_1
object
1 property1 required
New_Signer_From_Identity_Verification_custom_text
object
4 properties
Signer_info
object
5 properties5 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…
Signer_s_IP_address
Signer's public IP address at the time of signing. Private IP addresses (e.g. 10.x.x.x, 172.16-31.x.x, 192.168.x.x) are not accepted, as a public IP is require…
UnsupportedMediaTypeResponse
object
2 properties2 required
CreateSigner
object
FieldMention
object
12 properties11 required
FieldsInput
object
SmsNotification
object
1 property1 required
Checkbox_2
object
11 properties7 required
FieldSignature
object
11 properties11 required
New_Signer_From_Scratch_redirect_urls
object
3 properties
SignerIdentityVerification
object
3 properties2 required
MethodNotAllowed
object
1 property1 required
Locale
string
Locale settings used for communication.
Signer_fields_inner
SignerSignWithUploadedSignatureImage
object
4 properties3 required
SignatureDisplay
object
Controls what is shown within the signature field.
NotFoundResponse
object
2 properties2 required
Mention_2
object
9 properties6 required
Signer
object
Signer
20 properties20 required
BadRequestResponse
object
2 properties2 required
Signature_2
object
8 properties5 required
ForbiddenResponse
object
2 properties2 required
UnauthorizedResponse
object
2 properties2 required
SignatureDisplay_oneOf
object
1 property1 required
FieldText
object
18 properties15 required
New_Signer_From_Identity_Verification
object
Create a new signer from an identity verification
13 properties4 required
New_Signer_From_Identity_Verification_info
object
3 properties3 required
Font
object
4 properties4 required
New_Signer_From_Scratch_info
object
5 properties4 required
EmailNotification_1
object
1 property1 required
UpdateSigner_info
object
5 properties
UUID
string
The unique identifier for a resource.
OtpMessage
object
1 property1 required
CreateFieldDateFormat
string
Format used to display the date (e.g., dd/MM/yyyy, MM/dd/yyyy)
OTP_Message
object
1 property1 required
SignerSign
object
3 properties2 required
SignatureDisplay_oneOf_1_options
object
Only applicable when display.layout = detailed.
4 properties
RadioGroup_2
object
7 properties5 required
New_Signer_From_Existing_User_custom_text
object
4 properties
SignatureDisplay_oneOf_1
object
2 properties2 required
New_Signer_From_Existing_Contact
object
Create a new signer from an existing contact
14 properties2 required
FontFamily
string
CreateFieldTimeFormat
string
Format used to display the time. Can be null to display only the date, or a format like HH:mm or hh:mm a
CustomText
object
Custom Text
4 properties4 required
New_Signer_From_Scratch
object
Create a new signer from scratch
14 properties2 required
FontVariants
object
2 properties2 required
RadioGroup_2_radios_inner
object
5 properties2 required
FieldRadioButtonGroup_radios_inner
object
5 properties5 required
UpdateSigner
object
12 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
