Description (Update Beneficial Owner)
Update the selected Beneficial Owner. (PUT)
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 |
---|---|---|---|
1 | is_director | Boolean | Determine whether the beneficial owner creating is a director(default: false) |
2 | legal_name | String | Legal name of the beneficial owner (Not applicable for owner with user account i.e. user_id present) |
3 | date_of_birth | Date | Date of birth of the beneficial owner (format: YYYY-mm-dd) |
4 | proof_of_identity | String | Proof of identity of the beneficial owner (HKID/Passport number) |
5 | nationality | String | Nationality of the beneficial owner |
6 | percentage_owned | decimal | Percentage of benefit owned by the owner (Range: 10 - 100) |
Response
# | Name | Type | Description |
---|---|---|---|
1 | success | Boolean | Update Beneficial Owner Success or Fail |
2 | data | Array | Beneficial Owner Data (present if success) |
3 | message | String | Message (present if fail) |
4 | 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": "6M7V578", "company_id": "6M7V578", "user_id": "", "legal_name": "Xxxxx Xxxx", "date_of_birth": "2018-01-01", "proof_of_identity": "T123123(0)", "percentage_owned": 25, "nationality": "Hong Kong" } }
Example Error Response
{ "success": false, "message": "Unauthenticated.", "status": 500 }
v1.61.22-20230912 © The Payment Cards Group Limited. All rights reserved.