The relevant endpoint and http method information where individual accounts are listed are given below.
HTTP Method | URL |
---|---|
POST | /v1/Account/PersonalListByFilter |
Params | Type | Mandatory | Description |
---|---|---|---|
order_column | string | Yes | Order Column |
id | int | No | id |
tenant_id | int | No | Tenant ID |
account_id | int | No | Account ID |
account_number | string | No | Account Number |
national_id | string | No | National Id |
page_size | int | No | Page Size |
page_index | int | No | Page Index |
order_by | string | No | Order By |
first_name | string | No | Name |
last_name | string | No | Surname |
end_date | string | No | End Date |
start_date | string | No | Start Date |
access_level_status_id | string | No | Access Level Status ID |
kyc_level | int | No | KYC Level |
phone_number | string | No | Phone Number |
string | No | ||
phone_country_code | string | No | Country Phone Code |
is_account_locked | boolean | No | Is The Account Locked? |
group_code | string | No | Group Code |
Params | Type |
---|---|
status | int |
code | string |
message | string |
payload | object |
results | object |
id | string |
tenant_id | string |
account_number | string |
alias | string |
kyc_level | string |
owner_user_id | string |
phone_country_code | string |
phone_number | string |
string | |
user_kyc_info | obje |
first_name | string |
last_name | string |
birth_year | int |
kyc_level | int |
kyc_level_status | string |
national_id | string |
sector_id | string |
mother_name | string |
father_name | string |
access_level_status_id | int |
created_date_utc | string |
updated_date_utc | string |
contact_address_contact_first_name | string |
contact_address_contact_last_name | string |
contact_address_contact_email | string |
contact_address_contact_phone | string |
contact_address_address_line1 | string |
contact_address_address_line2 | string |
contact_address_zip_postal_code | string |
contact_address_state_province_code | string |
contact_address_country_code | string |
last_activity_date_utc | string |
last_failed_login_date_utc | string |
is_account_locked | boolean |
group_code | string |
page_index | int |
last_row_index | int |
page_count | int |
page_size | int |
row_count | int |
order_column | string |
order_by | string |
REQUEST (POST) :
{
"id": 0,
"tenant_id": 0,
"account_id": 0,
"account_number": "XXX",
"national_id": "3XX6XX1X0X0",
"page_size": 0,
"page_index": 0,
"order_column": "Id",
"order_by": "asc",
"first_name": "XXX",
"last_name": "XXX",
"end_date": "2021-11-14T17:41:26.644Z",
"start_date": "2021-11-14T17:41:26.644Z",
"access_level_status_id": "2",
"kyc_level": 10,
"phone_number": "5XX0XX0X0X",
"email": "none@example.com",
"phone_country_code": "90"
}
RESPONSE
{
"status": 0,
"code": null,
"message": null,
"payload": {
“results”: [
{
"id": "5555568855555684621",
"tenant_id": "5",
"account_number": "1227551959",
"alias": null,
"kyc_level": "Unverified",
"owner_user_id": "6568558505636550549",
"phone_country_code": "90",
"phone_number": "5222212222",
"email": null,
"user_kyc_info": {
"first_name": "john",
"last_name": "Doe",
"birth_year": 1995,
"kyc_level": 20,
"kyc_level_status": "Unverified",
"national_id": "22292222236",
"sector_id": null,
"mother_name": null,
"father_name": null
},
"access_level_status_id": 1,
"created_date_utc": "2021-12-15T11:16:15.3264299Z",
"updated_date_utc": null,
"contact_address_contact_first_name": null,
"contact_address_contact_last_name": null,
"contact_address_contact_email": null,
"contact_address_contact_phone": null,
"contact_address_address_line1": null,
"contact_address_address_line2": null,
"contact_address_zip_postal_code": null,
"contact_address_state_province_code": null,
"contact_address_country_code": null,
"last_activity_date_utc": null,
"last_failed_login_date_utc": null,
"is_account_locked": false,
"group_code": "",
},
],
“page_index”: 1,
“last_row_index”: 0,
“page_count”: 7,
"page_size": 100,
“row_count”: 68,
“order_column”: null,
“order_by”: null
}
}