API Reference
Status PageRoadmapTestimoniesShare feedback

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 Yousign 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
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 Yousign extracts from the applicant documents and verifications.

Responses

Updated 28 days 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 28 days ago