Applicant
Get an Applicant
Retrieves a given Applicant for a Workflow Session.
get/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
Response
OK
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"
}
}
}