Yedpay API Documentation

Description (Show Beneficial Owner)

Show a Beneficial Owner. (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.yedpay.com/v1/beneficial-owners/{{beneficial_owner_id}}?limit=50&page=1

End Point

https://api.yedpay.com/v1/beneficial-owners/{{beneficial_owner_id}}

Variable

Variable
#	Name	Type	Description
1	beneficial_owner_id	String	Beneficial Owner 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	Show 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	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": "VJ9310KLVW5O4LM26Y",
                        "company_id": "9302L8KRPEROEPRYJ7",
                        "user_id": "8YN319ZPL5EOX2DJ7P",
                        "is_director": false,
                        "legal_name": "Xxxxx Xxxxx",
                        "date_of_birth": "2022-11-27 08:46:56",
                        "proof_of_identity": "Xxxxxxxxxxx",
                        "percentage_owned": 40,
                        "nationality": "Hong Kong"
                    },
                    {
                        "id": "2NMJVPOM01PZ70RL8W",
                        "company_id": "P5631VZGY7QZN94JDX",
                        "user_id": null,
                        "is_director": false,
                        "legal_name": "Xxxxx Xxxxx",
                        "date_of_birth": "2017-06-17 08:46:56",
                        "proof_of_identity": "Xxxxxxxxxxx",
                        "percentage_owned": 32,
                        "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
            }