---
title: "Update an Applicant"
method: PATCH
path: "/workflow_sessions/{workflowSessionId}/applicants/{applicantId}"
tags: ["Applicant"]
---

# Update an Applicant

`PATCH /workflow_sessions/{workflowSessionId}/applicants/{applicantId}`

Updates a given Applicant for a Workflow Session.

## Path parameters

- `workflowSessionId` string, uuid, required — The unique identifier for a resource.
- `applicantId` string, uuid, required — The unique identifier for a resource.

## Request body

- UpdateWorkflowSessionApplicant — Update an Applicant associated with a Workflow Session (PATCH).
  - `label` string — Label of the Applicant.
  - `reference_id` string, nullable — Unique applicant identifier as registered on your side.
  - `delivery_mode` 'none' | 'email' — Delivery mode to notify Applicants.
  - `email` string, email, nullable — Preferred email address for managing notifications, required if delivery_mode is set to email.
  - `natural_person` UpdateNaturalPerson — Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.
    - `identity` Identity — Describes the Applicant.
      - `first_name` string, required — First name of the person.
      - `last_name` string, required — Last name of the person.
    - `address` Address — Provide the Applicants full address.
      - `line1` string, required — The first line of the address, typically the street name and number.
      - `line2` string, nullable — If needed, the second line of the address, typically an apartment or suite number.
      - `postal_code` string, required — The postal code of the address.
      - `city` string, required — The city of the address.
    - `bank_account` BankAccount, nullable — Bank account details.
      - `iban` string, required — International Bank Account Number.
      - `bic` string, nullable — Business Identifier Code.
  - `legal_person` UpdateLegalPerson — Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.
    - `company_name` string, nullable — Name of the company.
    - `country_code` 'FR' | 'null', nullable — Country code of the company (ISO 3166-1 alpha-2).
    - `bank_account` BankAccount, nullable — Bank account details.
      - `iban` string, required — International Bank Account Number.
      - `bic` string, nullable — Business Identifier Code.
    - `legal_representatives` Identity[] — Legal representatives of the company.
      - `first_name` string, required — First name of the person.
      - `last_name` string, required — Last name of the person.

## Response `200`

OK

- union — An Applicant associated with a Workflow Session (full view).
  - NaturalPersonApplicant — A natural person Applicant.
    - `id` string, uuid, required — Unique identifier of the Applicant.
    - `workflow_session_id` string, uuid, required — Unique identifier of the Workflow Session.
    - `status` 'initiated' | 'notified' | 'processed', required — Status of the Applicant.
    - `label` string, required — Label of the Applicant.
    - `reference_id` string, nullable, required — Unique applicant identifier as registered on your side.
    - `delivery_mode` 'none' | 'email', required — Delivery mode to notify Applicants.
    - `email` string, email, nullable, required — Preferred email address for managing notifications, required if delivery_mode is set to email.
    - `created_at` string, date-time, required — Creation date of the Applicant.
    - `updated_at` string, date-time, required — Last update date of the Applicant.
    - `type` 'natural_person', required — Type of the Applicant.
    - `natural_person` NaturalPerson, required — Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.
      - `identity` Identity, required — Describes the Applicant.
        - `first_name` string, required — First name of the person.
        - `last_name` string, required — Last name of the person.
      - `address` Address, required — Provide the Applicants full address.
        - `line1` string, required — The first line of the address, typically the street name and number.
        - `line2` string, nullable — If needed, the second line of the address, typically an apartment or suite number.
        - `postal_code` string, required — The postal code of the address.
        - `city` string, required — The city of the address.
      - `bank_account` BankAccount, nullable, required — Bank account details.
        - `iban` string, required — International Bank Account Number.
        - `bic` string, nullable — Business Identifier Code.
  - LegalPersonApplicant — A legal person Applicant.
    - `id` string, uuid, required — Unique identifier of the Applicant.
    - `workflow_session_id` string, uuid, required — Unique identifier of the Workflow Session.
    - `status` 'initiated' | 'notified' | 'processed', required — Status of the Applicant.
    - `label` string, required — Label of the Applicant.
    - `reference_id` string, nullable, required — Unique applicant identifier as registered on your side.
    - `delivery_mode` 'none' | 'email', required — Delivery mode to notify Applicants.
    - `email` string, email, nullable, required — Preferred email address for managing notifications, required if delivery_mode is set to email.
    - `created_at` string, date-time, required — Creation date of the Applicant.
    - `updated_at` string, date-time, required — Last update date of the Applicant.
    - `type` 'legal_person', required — Type of the Applicant.
    - `legal_person` LegalPerson, required — Contains information that describe the applicant. This data is used for cross-validation with the data Youtrust extracts from the applicant documents and verifications.
      - `company_name` string, nullable, required — Name of the company.
      - `country_code` string, nullable, required — Country code of the company (ISO 3166-1 alpha-2).
      - `bank_account` BankAccount, nullable, required — Bank account details.
        - `iban` string, required — International Bank Account Number.
        - `bic` string, nullable — Business Identifier Code.
      - `legal_representatives` Identity[], required — Legal representatives of the company.
        - `first_name` string, required — First name of the person.
        - `last_name` string, required — Last name of the person.

## Other responses

- `400` — Bad request
- `401` — Access unauthorized
- `403` — Access forbidden
- `404` — Resource not found
- `405` — This method is not allowed
- `429` — Too Many Requests, please try again later.
- `500` — Internal Server Error

---

[API](https://skmtc.net/yousign/apis/public-api-v3.md) · [All operations](https://skmtc.net/yousign/apis/public-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yousign/public-api-v3/revisions/8d258c0b45d6/schema)