Description (Beneficial Owner List)
Show the list of all the Beneficial Owners. (GET)
End Point
https://api.yedpay.com/v1/beneficial-owners
Variable
# | Name | Type | Description |
---|---|---|---|
1 | company_id | String | Company's ID |
Request Header
# | Key | Value | Description |
---|---|---|---|
1 | Authorization | Bearer {{access_token}} | Login Token |
Body
# | Name | Type | Description |
---|
Response
# | Name | Type | Description |
---|---|---|---|
1 | success | Boolean | Request Beneficial Owner List Success or Fail |
2 | data | Array | Include all Beneficial Owner Information (id, legal name, date of birth, etc..) |
3 | meta | Array | Include all Pagination's Information (total, count, total_pages, etc..) |
Success Response - data
# | Name | Type | Description |
---|---|---|---|
1 | id | String | Unique identifier of the beneficial owner |
2 | company_id | String | Unique identifier of the company that beneficial owner belongs to |
3 | user_id | String | Unique identifier of the user that beneficial owner related to |
4 | is_director | Boolean | Boolean determine whether the beneficial owner is director |
5 | legal_name | String | Legal name of the beneficial owner |
6 | date_of_birth | String | Date of birth of the beneficial owner |
7 | proof_of_identity | String | Proof of idenetity of the beneficial owner |
8 | percentage_owned | Float | Percentage of benefit owned by the owner |
9 | nationality | String | Nationality of the beneficial owner |
Example Success Response
{ "success": true, "data": [ { "id": "9302L8KR3LLZEPRYJ7", "company_id": "M49E60Z75GGK17G5DN", "user_id": "6YEXR4KEJ82Z3N8QG5", "is_director": true, "legal_name": "Xxxxx Xxxxx", "date_of_birth": "2015-05-22 02:18:13", "proof_of_identity": "Xxxxxxxxxxx", "percentage_owned": 41, "nationality": "Hong Kong" }, { "id": "3GWX1LKVD46KER4NYP", "company_id": "6PEQD4O49EMK5VY8W3", "user_id": null, "is_director": false, "legal_name": "Xxxxx Xxxxx", "date_of_birth": "2020-03-15 02:18:13", "proof_of_identity": "Xxxxxxxxxxx", "percentage_owned": 27, "nationality": "Hong Kong" } ], "meta": { "pagination": { "total": 2, "count": 2, "per_page": 40, "current_page": 1, "total_pages": 1, "links": [] } } }
Example Error Response
{ "success": false, "message": "Unauthenticated.", "status": 500 }
v1.66.2-20240423 © The Payment Cards Group Limited. All rights reserved.