API Reference

Initiate a new signature request

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

Initiate a new signature request

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 128

Name of the signature request

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

reminder_settings
object | null

Enable automatic reminders for pending signers.

string

tz database format

string
length ≤ 500

A custom note added to emails sent to signers.

date

Due date of the signature request. Default to 6 month after the activation.

uuid
^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Create a signature request from an existing template.

string | null
^[\w\-@.%+]+$

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

uuid | null
^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Use a specific branding to customize the signature experience.

documents
array of uuids, unique
length ≤ 5
deprecated

You can directly attach orphan documents to the signature request.

documents
signers
array
deprecated

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

signers
custom_text
object
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?