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.2.0, at version 3.0.
Requests are made against 2 base URLs: https://api-sandbox.yousign.app/v3, https://api.yousign.app/v3.
The identity and technical contract details declared by the specification.
CustomPropertyValue
object
6 properties
3 required
Text_2
object
14 properties
8 required
SignatureRequest_email_notification
object
2 properties
2 required
SignatureRequest_decline_information
objectnull
3 properties
UUID
string
The unique identifier for a resource.
ForbiddenResponse
object
2 properties
2 required
SignatureRequest
object
34 properties
29 required
NotFoundResponse
object
2 properties
2 required
Archiving
stringnull
Once the signature request completed, archive its documents in a secure digital safe
SignatureRequest_email_notification_sender
object
2 properties
2 required
New_Signature_Request_From_Scratch_signers_inner
Create signers
CustomPropertyInList
object
8 properties
3 required
New_Signature_Request_From_Scratch_template_placeholders
objectnull
When creating a signature request from a template, all substituting data for placeholders defined in the given template.
2 properties
Signature_2
object
8 properties
5 required
Locale
string
Locale settings used for communication.
post_signature_requests_signatureRequestId_reactivate_request
object
1 property
1 required
Pagination
object
Metadata about the response.
1 property
1 required
SignatureRequest_EmailNotification_custom_text
objectnull
4 properties
post_signature_requests_signatureRequestId_cancel_request
object
2 properties
1 required
SignatureRequest_EmailNotification_Sender
object
2 properties
ApproverToNotify
object
4 properties
4 required
get_signature_requests_200_response
object
2 properties
CustomPropertyOption
object
4 properties
4 required
SignatureRequest_SignerFromInfoInput_redirect_urls
object
2 properties
SignatureRequestActivated
object
27 properties
25 required
SignatureRequest_PlaceholderSignerSubstituteFromContactIdInput
object
Create a placeholder signer substitute from a contact
7 properties
2 required
SignatureRequest_PlaceholderSignerSubstituteFromUserIdInput
object
Create a placeholder signer substitute from a user
7 properties
2 required
CreateSignatureRequest
object
SignatureRequest_EmailNotification
objectnull
3 properties
SignatureRequest_PlaceholderSignerSubstituteFromInfoInput
object
Create a placeholder signer substitute from info
7 properties
2 required
RadioGroup_2
object
7 properties
5 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
Checkbox_2
object
11 properties
7 required
EmbeddedSignerWithSignatureLink
object
4 properties
4 required
SignatureRequestInList
object
31 properties
27 required
CustomPropertyType
string
UnauthorizedResponse
object
2 properties
2 required
New_Signature_Request_From_Scratch
object
Create a new Signature Request from scratch
24 properties
2 required
ActivateSignatureRequest
object
1 property
SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_redirect_urls
object
3 properties
SignatureRequestInList_reminder_settings
objectnull
2 properties
2 required
MethodNotAllowed
object
1 property
1 required
New_Signature_Request_From_Scratch_reminder_settings
objectnull
Enable automatic reminders for pending Signers.
2 properties
2 required
RadioGroup_2_radios_inner
object
5 properties
2 required
SignatureRequest_rejection_information
objectnull
Information related to the rejection of a Signature Request by an Approver.
3 properties
UpdateSignatureRequest_reminder_settings
objectnull
2 properties
2 required
SignatureRequest_SignerFromInfoInput_custom_text
object
4 properties
SignatureRequestLabel
object
2 properties
2 required
UpdateSignatureRequest
object
16 properties
SignatureRequest_SignerFromInfoInput_info
object
create new signer
5 properties
4 required
PreviousAttemptId
stringnull
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.
New_Signature_Request_From_Scratch_template_placeholders_signers_inner
SignatureRequest_SignerFromContactIdInput
object
Create signer from a contact
7 properties
2 required
SignatureRequest_SignerFromUserIdInput
object
Create a signer from a user
7 properties
2 required
SignatureRequestInList_approvers_inner
object
2 properties
2 required
InternalServerError
object
2 properties
2 required
UnsupportedMediaTypeResponse
object
2 properties
2 required
SignatureRequestInList_sender
objectnull
2 properties
BadRequestResponse
object
2 properties
2 required
SignatureRequestInList_signers_inner
object
2 properties
2 required
SignatureRequestInList_documents_inner
object
2 properties
2 required
SignatureRequestStatus
string
SignatureRequest_SignerFromInfoInput
object
Create a signer from info
7 properties
2 required
SignatureRequest_PlaceholderReadOnlyTextFieldSubstituteInput
object
Create a placeholder readonlytext field substitute
2 properties
2 required
SignerDeliveryMode
stringnull
Override the delivery mode of the Signature Request for this Signer
Mention_2
object
9 properties
6 required
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…
TooManyRequestsResponse
object
1 property
1 required
WorkflowSessionId
stringnull
Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.
SignatureRequestActivated_documents_inner
object
2 properties
2 required
SignatureRequest_PlaceholderSignerSubstituteFromInfoInput_info
object
Create new signer
5 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs YouSign publishes across the network.
