API Reference
Status PageRoadmapTestimoniesShare feedback
Start typing to search…

Initiate a new Signature Request

post
https://api-sandbox.yousign.app/v3/signature_requests

Creates a new Signature Request resource.

Body Params
string
required
length between 1 and 128

Name of the signature request.
This property is a Safe String.

string
enum
required

Delivery mode to notify Signers.

Allowed:
boolean

Enable an ordered workflow, each Signer will be requested to sign in a sequential order

boolean

When enabled, Approvers are requested to approve sequentially. Each Approver will be invited to approve only once the previous one has completed their approval.

boolean

When enabled, Approvers and Signers are requested to approve depending of a sequence composed of stages. Every recipients present in a stage will be invited to approve or sign parallelly, and stages are sequential each other. When custom_recipient_order is enabled, ordered_approvers and ordered_signers are ignored.

reminder_settings
object | null

Enable automatic reminders for pending Signers.

string
Defaults to Europe/Paris

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 Europe/Paris.

string | null
deprecated

A custom note added to emails sent to signers.
This property is a Safe String allowing email and leading or trailing whitespaces.

date

Due date of the Signature Request (yyyy-mm-dd). Defaults to 6 months after initiation. The date cannot be in the past and cannot be more than one year after initiation.

uuid

Create a Signature Request from an existing template.

string | null

Store a custom id that will be added to webhooks & appended to redirect urls.

uuid | null
deprecated

Use a specific branding to customize the signature experience.

uuid | null

Use a specific Custom Experience to customize the signature experience.

documents
array of uuids
length ≤ 5
deprecated

You can directly attach orphan Documents to the Signature Request.

documents
signers
array of objects
deprecated

Can only be used if you add documents at the same time.

signers
uuid | null

Scope the signature request to a specific workspace. If template_id is filled and Template is already linked to a Workspace, keep this field to null ; the created Signature Request will be scoped to Template's Workspace.

string | null
enum

Define the locale for the generated audit trail.

Allowed:
boolean
Defaults to false

Allowing signers to decline to sign.

email_notification
object | null
template_placeholders
object | null

When creating a signature request from a template, all substituting data for placeholders defined in the given template.

string | null
enum
deprecated

Once the signature request completed, archive its documents in a secure digital safe

Allowed:
labels
array of uuids
length ≤ 50

List of Labels to associate with the Signature Request. Labels are identified by their ID.

labels
uuid | null

Unique identifier of a Workflow Session. When provided, an Action is created in the Workflow Session, and this resource is associated with that Action.

uuid | null

ID of the previous attempt within the same workflow_session_id. Allows continuity between multiple attempts of the same Action. Null if this is the first attempt.

Responses

Updated 5 days ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 days ago