YouSign Signature Request API
Process of inviting Signers to sign a Document.
YouSign Signature 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 Signature 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 8 operations across 5 paths, and defines 74 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.
8 operations
5 paths
74 schemas
1 DELETE2 GET1 PATCH4 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
YouSign Signature Request 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, 2 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Signature Request 8
Process of inviting Signers to sign a Document.
GET
/signature_requests
List Signature Requests
POST
/signature_requests
Initiate a new Signature Request
DELETE
/signature_requests/{signatureRequestId}
Delete a Signature Request
GET
/signature_requests/{signatureRequestId}
Fetch a Signature Request
PATCH
/signature_requests/{signatureRequestId}
Update a Signature Request
POST
/signature_requests/{signatureRequestId}/activate
Activate a Signature Request
POST
/signature_requests/{signatureRequestId}/cancel
Cancel a Signature Request
POST
/signature_requests/{signatureRequestId}/reactivate
Reactivate an expired Signature Request
Schemas 74
The contract defines 74 schemas that model the data the API accepts and returns. The most detailed are SignatureRequest (34 properties), SignatureRequestInList (31 properties), SignatureRequestActivated (27 properties), New_Signature_Request_From_Scratch (24 properties). Each schema is shown below with its type and property counts.
CustomPropertyType
string
EmbeddedSignerWithSignatureLink
object
4 properties
4 required
UpdateSignatureRequest
object
16 properties
New_Signature_Request_From_Scratch
object
Create a new Signature Request from scratch
24 properties
2 required
TooManyRequestsResponse
object
1 property
1 required
SignatureRequestInList_approvers_inner
object
2 properties
2 required
post_signature_requests_signatureRequestId_reactivate_request
object
1 property
1 required
SignatureRequest
object
34 properties
29 required
FieldsInput
object
SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_info
object
Create new signer
5 properties
4 required
Locale
string
Locale settings used for communication.
SignatureRequest_PlaceholderSignerSubstituteFromInfoInput
object
Create a placeholder signer substitute from info
7 properties
2 required
NotFoundResponse
object
2 properties
2 required
SignatureRequest_rejection_information
object
Information related to the rejection of a Signature Request by an Approver.
3 properties
get_signature_requests_200_response
object
2 properties
SignatureRequestInList_sender
object
2 properties
SignatureRequestInList_documents_inner
object
2 properties
2 required
SignatureRequest_PlaceholderSignerSubstituteFromUserIdInput
object
Create a placeholder signer substitute from a user
7 properties
2 required
SignerDeliveryMode
string
Override the delivery mode of the Signature Request for this Signer
SignatureRequest_SignerFromInfoInput_info
object
create new signer
5 properties
4 required
Text_2
object
14 properties
8 required
SignatureRequest_PlaceholderReadOnlyTextFieldSubstituteInput
object
Create a placeholder readonlytext field substitute
2 properties
2 required
CustomPropertyValue
object
6 properties
3 required
AuditTrailLocale
string
UnsupportedMediaTypeResponse
object
2 properties
2 required
SignatureRequest_SignerFromInfoInput
object
Create a signer from info
7 properties
2 required
Mention_2
object
9 properties
6 required
SignatureRequest_EmailNotification
object
3 properties
New_Signature_Request_From_Scratch_template_placeholders
object
When creating a signature request from a template, all substituting data for placeholders defined in the given template.
2 properties
ApproverToNotify
object
4 properties
4 required
ActivateSignatureRequest
object
1 property
RadioGroup_2
object
7 properties
5 required
UpdateSignatureRequest_reminder_settings
object
2 properties
2 required
CustomPropertyOption
object
4 properties
4 required
WorkflowSessionId
string
Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.
Pagination
object
Metadata about the response.
1 property
1 required
New_Signature_Request_From_Scratch_template_placeholders_signers_inner
SignatureRequestLabel
object
2 properties
2 required
SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_redirect_urls
object
3 properties
HumanName
string
SignatureRequest_SignerFromInfoInput_redirect_urls
object
2 properties
Archiving
string
Once the signature request completed, archive its documents in a secure digital safe
SignatureRequest_email_notification
object
2 properties
2 required
New_Signature_Request_From_Scratch_signers_inner
Create signers
SignatureRequest_PlaceholderSignerSubstituteFromContactIdInput
object
Create a placeholder signer substitute from a contact
7 properties
2 required
MethodNotAllowed
object
1 property
1 required
SignatureRequest_decline_information
object
3 properties
BadRequestResponse
object
2 properties
2 required
ForbiddenResponse
object
2 properties
2 required
post_signature_requests_signatureRequestId_cancel_request
object
2 properties
1 required
UnauthorizedResponse
object
2 properties
2 required
SignatureRequestActivated_documents_inner
object
2 properties
2 required
SignatureRequestActivated
object
27 properties
25 required
Duplicate_a_Signature_Request
object
Duplicate a Signature Request. It will be added to the same workspace as the original.
4 properties
1 required
RadioGroup_2_radios_inner
object
5 properties
2 required
SignatureRequest_EmailNotification_Sender
object
2 properties
SignatureRequestTimeZone
string
Time zone of the dates and times displayed in emails, the Signature Request expiration date, and the PDF Audit Trail. Format: tz database. Default is set to Eu…
InternalServerError
object
2 properties
2 required
SignatureRequestInList
object
31 properties
27 required
SignatureRequest_SignerFromUserIdInput
object
Create a signer from a user
7 properties
2 required
Checkbox_2
object
11 properties
7 required
New_Signature_Request_From_Scratch_reminder_settings
object
Enable automatic reminders for pending Signers.
2 properties
2 required
CustomPropertyInList
object
8 properties
3 required
SignatureRequest_email_notification_sender
object
2 properties
2 required
Signature_2
object
8 properties
5 required
SignatureRequestStatus
string
SignatureRequestInList_signers_inner
object
2 properties
2 required
UUID
string
The unique identifier for a resource.
CreateSignatureRequest
object
SignatureRequest_SignerFromContactIdInput
object
Create signer from a contact
7 properties
2 required
SignatureRequest_SignerFromInfoInput_custom_text
object
4 properties
PreviousAttemptId
string
ID of the previous attempt within the same workflowsessionid. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.
SignatureRequestInList_reminder_settings
object
2 properties
2 required
SignatureRequest_EmailNotification_custom_text
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from YouSign 12
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
#Signature Request