Sign in

v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Applicant

Update an Applicant

Updates a given Applicant for a Workflow Session.

patch/workflow_sessions/{workflowSessionId}/applicants/{applicantId}

Path parameters

workflowSessionIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Workflow Session Id

applicantIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Applicant Id

Request body

labelstring

Label of the Applicant.

reference_idstring nullable

Unique applicant identifier as registered on your side.

delivery_mode'none' | 'email'

Delivery mode to notify Applicants.

emailstring email nullable

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

Example request

{
  "label": "John Doe",
  "reference_id": "REF-12345",
  "delivery_mode": "email",
  "email": "applicant@example.com",
  "natural_person": {
    "identity": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "address": {
      "line1": "1 rue de la Paix",
      "postal_code": "75002",
      "city": "Paris"
    },
    "bank_account": {
      "iban": "FR7630001007941234567890185",
      "bic": "BDFEFR2L"
    }
  },
  "legal_person": {
    "company_name": "Acme",
    "country_code": "FR",
    "bank_account": {
      "iban": "FR7630001007941234567890185",
      "bic": "BDFEFR2L"
    },
    "legal_representatives": [
      {
        "first_name": "John",
        "last_name": "Doe"
      }
    ]
  }
}

Response

OK

OR

Example response

{
  "id": "9a93d3b5-fb3b-4abf-9e70-26315b33506c",
  "workflow_session_id": "0ef334d2-7f36-4643-8a2a-4283b4a3e4a4",
  "status": "initiated",
  "label": "John Doe",
  "reference_id": "REF-12345",
  "delivery_mode": "email",
  "email": "applicant@example.com",
  "created_at": "2024-01-18T22:59:00Z",
  "updated_at": "2024-01-18T22:59:00Z",
  "natural_person": {
    "identity": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "address": {
      "line1": "1 rue de la Paix",
      "postal_code": "75002",
      "city": "Paris"
    },
    "bank_account": {
      "iban": "FR7630001007941234567890185",
      "bic": "BDFEFR2L"
    }
  }
}