API Reference
Status PageRoadmapTestimoniesShare feedback
  1. Workflows
  2. Applicants

Update an Applicant

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

Updates a given Applicant for a Workflow Session.

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

🔓 Endpoint access

  • Environments: production, sandbox
  • API key scopes: organization, workspace
  • Plans: plus, pro, scale
  • Add-ons (for production access): none
Path Params
uuid
required

Workflow Session Id

uuid
required

Applicant Id

Body Params

Update an Applicant associated with a Workflow Session (PATCH).

string
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.

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.

legal_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.

Responses

Updated 4 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 4 months ago