Yedpay API Documentation

Description (Beneficial Owner List)

Show the list of all the Beneficial Owners. (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/beneficial-owners?limit=50&page=1

End Point

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

Variable

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

Request Header

Request Header
#	Key	Value	Description
1	Authorization	Bearer {{access_token}}	Login Token

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	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	first_name	String	First name of the beneficial owner
7	last_name	String	Last name of the beneficial owner
8	date_of_birth	String	Date of birth of the beneficial owner
9	proof_of_identity	String	Proof of identity of the beneficial owner
10	percentage_owned	Float	Percentage of benefit owned by the owner
11	nationality	String	Nationality of the beneficial owner

Example Success Response

            {
                "success": true,
                "data": [
                    {
                        "id": "ELQYZKRK",
                        "company_id": "4RODX8LJ",
                        "user_id": "JRJ3V1L9",
                        "is_director": false,
                        "legal_name": "Xxxxx Xxxxx",
                        "date_of_birth": "2022-08-14 11:28:17",
                        "proof_of_identity": "Xxxxxxxxxxx",
                        "percentage_owned": 15,
                        "nationality": "Hong Kong"
                    },
                    {
                        "id": "1L2PJ1LK",
                        "company_id": "ER1QVJ6Z",
                        "user_id": null,
                        "is_director": true,
                        "legal_name": "Xxxxx Xxxxx",
                        "date_of_birth": "2019-03-01 11:28:17",
                        "proof_of_identity": "Xxxxxxxxxxx",
                        "percentage_owned": 31,
                        "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
            }