Yedpay

Description (Create Beneficial Owner)

Create a Beneficial Owner. (POST)

End Point

https://api.yedpay.com/v1/beneficial-owners

Request Header

Request Header
# Key Value Description
1 Authorization Bearer {{access_token}} Login Token
2 Content-Type application/x-www-form-urlencoded x-www-form-urlencoded

Body

Body
# Name Type Description
1 company_id String Id of beneficial owner's company
2 user_id String (Optional) Id of beneficial owner's user account
3 is_director Boolean Determine whether the beneficial owner creating is a director(default: false)
4 legal_name String (Required if user_id is absent)Legal name of the beneficial owner
5 date_of_birth Date Date of birth of the beneficial owner (format: YYYY-mm-dd)
6 proof_of_identity String Proof of identity of the beneficial owner (HKID/Passport number)
7 percentage_owned decimal Percentage of benefit owned by the owner (Range: 10 - 100)
8 nationality String Nationality of the beneficial owner

Response

Response
# Name Type Description
1 success Boolean Create Beneficial Owner Success or Fail
2 data Array Success or Fail Message
3 status Array Status code(optional)

Success Response - data

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": "03QYVJKQR66ON8LM51",
                    "company_id": "MJ86QYO3XDWZEP3RG5",
                    "user_id": "3WJ2PMK6NRJK7Y6DN5",
                    "is_director": true,
                    "legal_name": "Xxxxx Xxxxx",
                    "date_of_birth": "2016-12-19 08:26:58",
                    "proof_of_identity": "Xxxxxxxxxxx",
                    "percentage_owned": 27,
                    "nationality": "Hong Kong"
                }
            }

Example Error Response

            {
                "success": false,
                "message": "Unauthenticated.",
                "status": 500
            }
        

v1.59.0-20220801 © The Payment Cards Group Limited. All rights reserved.