Description (Show Beneficial Owner)
Show a Beneficial Owner. (GET)End Point
https://api.yedpay.com/v1/beneficial-owners/{{beneficial_owner_id}}
Variable
# | Name | Type | Description |
---|---|---|---|
1 | beneficial_owner_id | String | Beneficial Owner ID |
Request Header
# | Key | Value | Description |
---|---|---|---|
1 | Authorization | Bearer {{access_token}} | Login Token |
Body
# | Name | Type | Description |
---|
Response
# | Name | Type | Description |
---|---|---|---|
1 | success | Boolean | Show Beneficial Owner Success or Fail |
2 | data | Array | Success or Fail Message |
3 | status | Array | Status code(optional) |
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": "7VEXG3O82NMOY4PD0N", "company_id": "P5631VZGPENZN94JDX", "user_id": "2NMJVPOMVGVO70RL8W", "is_director": true, "legal_name": "Xxxxx Xxxxx", "date_of_birth": "2011-12-11 05:59:23", "proof_of_identity": "Xxxxxxxxxxx", "percentage_owned": 39, "nationality": "Hong Kong" }, { "id": "2NMJVPOMJL6O70RL8W", "company_id": "P5631VZGV87ZN94JDX", "user_id": null, "is_director": true, "legal_name": "Xxxxx Xxxxx", "date_of_birth": "2017-07-25 05:59:23", "proof_of_identity": "Xxxxxxxxxxx", "percentage_owned": 13, "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.61.15-20230523 © The Payment Cards Group Limited. All rights reserved.