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": "P5631VZGJ17ZN94JDX", "company_id": "7VEXG3O8268OY4PD0N", "user_id": "03QYVJKQVJ5ZN8LM51", "is_director": false, "legal_name": "Xxxxx Xxxxx", "date_of_birth": "2011-01-26 12:19:12", "proof_of_identity": "Xxxxxxxxxxx", "percentage_owned": 21, "nationality": "Hong Kong" }, { "id": "WJ3459ZDQMQKY1RP8V", "company_id": "WP5631VZGY7ZN94JDX", "user_id": null, "is_director": true, "legal_name": "Xxxxx Xxxxx", "date_of_birth": "2014-09-24 12:19:12", "proof_of_identity": "Xxxxxxxxxxx", "percentage_owned": 50, "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.65.0-20240318 © The Payment Cards Group Limited. All rights reserved.