Yedpay API Documentation

Description (Company's Beneficial Owner List)

Show the list of all the Beneficial Owner related with the company. (GET)

Queries

In order to search you can add in the url the follow parameters.

* limit - control the records show on each page (if not set, default load 40 records)
* page - control load the number of the page

Example:

https://api-h2h-staging.yedpay.com/v1/companies/{{company_id}}/beneficial-owners?limit=50&page=1

End Point

https://api-h2h-staging.yedpay.com/v1/companies/{{company_id}}/beneficial-owners

Variable

Variable
#	Name	Type	Description
1	company_id	String	Company's ID

Request Header

Request Header
#	Key	Value	Description

Body

Body
#	Name	Type	Description

Response

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

Success Response - data
#	Name	Type	Description
1	id	String	Id of the beneficial owner
2	company_id	String	Id of beneficial owner's company
3	user_id	String	Id of beneficial owner's user account
4	legal_name	String	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	nationality	String	Nationality of the beneficial owner
8	percentage_owned	Float	Percentage of benefit owned by the owner

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "6M7V578",
                        "company_id": "6M7V578",
                        "user_id": "6M7V578",
                        "legal_name": "Xxxxx Xxxxx",
                        "date_of_birth": "2018-01-01",
                        "proof_of_identity": "T123123(0)",
                        "percentage_owned": 25,
                        "nationality": "Hong Kong"
                    }
                ],
                "meta": {
                    "pagination": {
                        "total": 1
                        "count": 1,
                        "per_page": 40,
                        "current_page": 1,
                        "total_pages": 1,
                        "links": []
                    }
                }
            }

Example Error Response

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