API Reference
Status PageRoadmapTestimoniesShare feedback
  1. Workflows
  2. Applicants

Create a new Applicant

post
https://api-sandbox.yousign.app/v3/workflow_sessions//applicants

Creates a new Applicant for a given Workflow Session.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Workflow Session Id

Body Params

Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.

string
required
length between 1 and 255

Label of the Applicant.

string | null

Unique applicant identifier as registered on your side.

string
enum
Defaults to none

Delivery mode to notify Applicants.

Allowed:
string | null

Preferred email address for managing notifications, required if delivery_mode is set to email.

string
enum
required

Type of the Applicant.

Allowed:
natural_person
object

Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.

uuid | null

The id of the parent Applicant (should be a legal_person in the same Workflow Session). Can be changed until the first magic link has been generated for the Workflow Session; once a link exists the parent is immutable and any attempt to change it returns a 400 error.

string | null
enum

Role of the Applicant towards its parent legal person. Only meaningful on a child Applicant; used by the Workflow Collect link to group the documents of legal representatives and beneficial owners. Null when not set.

Allowed:
redirect_urls
object | null

URLs the Applicant is redirected to at the end of the Workflow Session link journey, outside an iframe: success once every action is done, error once an action is blocked. A null field falls back to the Custom Experience. Not allowed on a child Applicant (400). Not available while the subscription is in trial (400). On update, an omitted field keeps its value and a null field clears it.

Responses

Updated 6 months ago

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 6 months ago