GET
/
api
/
v1
/
clients
/
{client_id}
/
onboarding
/
status
Get Customer Onboarding Progress Status
curl --request GET \
  --url http://localhost:8080/api/v1/clients/{client_id}/onboarding/status
{
  "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "overall_status": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "kyc_application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kyc_link": "<string>"
}

Path Parameters

​
client_id
string<uuid>
required

Client UUID

Response

Onboarding status retrieved successfully

​
client_id
string<uuid>
required
​
created_at
string<date-time>
required
​
current_step
enum<string>
required

Onboarding Step - Current step in the onboarding process

Available options:
DETAILS_PENDING,
KYC_PENDING,
KYC_PROCESSING,
KYC_UNDER_REVIEW,
KYC_DECLINED,
PENDING_APPROVAL,
APPROVED
​
id
string<uuid>
required
​
kyc_status
enum<string>
required

Verification Status - Status of verifications

Available options:
NOT_STARTED,
CREATED,
PROCESSING,
PENDING_REVIEW,
VALIDATED,
DECLINED,
ABORTED
​
overall_status
string
required
​
updated_at
string<date-time>
required
​
kyc_application_id
string<uuid> | null
​
kyc_link
string | null