GET Individual Client Overview
URL : /api/v1/records/individual/overview/
Method : GET
Auth required : YES
Parameters
| Parameter | Type | Description |
|---|---|---|
| reference_id | number | The unique reference ID of client. |
| group_token (optional) | number | The unique group token. |
Response
The response will contain a JSON object with the following fields:
| Field | Type | Description |
|---|---|---|
status_code | int | The status_code. |
message | string | message. |
data | array | data. |
Each object in the data array will have the following fields:
| Field | Type | Description |
|---|---|---|
client_details | object | The details of the client. |
individual_overview | object | The overview of the onboarded client. |
Here's an example response:
Code : 200 OK
👾
**Success Response.
Content examples
Request
/api/v1/records/individual/overview?reference_id=test&group_token=test
Response
{
"status_code": 200,
"message": "Success",
"data": {
"client_details": {
"reference_id": "1688582123720-7820",
"group_token": "96778a45-1670-4367-a279-1a6cc0fa957a",
"client_email": "hiqozy@mailinator.com",
"client_status": "active",
"request_status": "completed"
},
"individual_overview": {
"country": "Germany",
"first_name": "Rudyard",
"last_name": "Gilbert",
"email": "dygepaj@mailinator.com",
"date_of_birth": "1997-01-01",
"address": "Non necessitatibus e",
"city": "Quis necessitatibus ",
"state": "Est minim vel volupt",
"postcode": "Provident soluta ex"
}
}
}