API Test Keys

Fetch All Stakeholders

GET

/v2/accounts/:account_id/stakeholders

Click to copy

Use this endpoint to retrieve the details of all stakeholders for a given account. Know about the

various error responses

for this API.

Is this page helpful?

Curl

change language

1curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2- X GET https://api.razorpay.com/v2/accounts/acc_GLGeLkU2JUeyDZ/stakeholders   \

Success

1{
2  "entity": "collection",
3  "items": [
4    {
5      "id": "GZ13yPHLJof9IE",
6      "entity": "stakeholder",
7      "relationship": {
8        "director": true
9      },
10      "phone": {
11        "primary": "9000090000",
12        "secondary": "9000090000"
13      },
14      "notes": {
15        "random_key_by_partner": "random_value"
16      },
17      "kyc": {
18        "pan": "AVOPB1111K"
19      },
20      "name": "Gaurav Kumar",
21      "email": "gaurav.kumar@acme.org",
22      "percentage_ownership": 10,
23      "addresses": {
24        "residential": {
25          "street": "506, Koramangala 1st block",
26          "city": "Bengaluru",
27          "state": "Karnataka",
28          "postal_code": "560034",
29          "country": "in"
30        }
31      }
32    }
33  ],
34  "count": 1
35}

Path Parameters

account_id

string

The unique identifier of a sub-merchant account generated by Razorpay. For example, acc_GLGeLkU2JUeyDZ.

Response Parameters

id

string

The unique identifier of a stakeholder generated by Razorpay, used to fetch or update a stakeholder. For example, sth_GLGgm8fFCKc92m. Maximum length supported is 18 characters.

percentage_ownership

float

The stakeholder's ownership of the business in percentage. Only two decimal places are allowed. For example, 87.55. The maximum length is 100 characters.

name

string

The stakeholder's name as per the PAN card. The maximum length is 255 characters.

email

string

The stakeholder's email address. The maximum length is:

local part (before @): 64 characters.
domain part (after @): 68 characters.
The total character length supported is 132.

relationship

object

The stakeholder's relationship with the account’s business. The default value is false.

director: This attribute is set to true if the stakeholder is a director of the account's legal entity. By default, it is set to false.
executive: This attribute is set to true if the stakeholder is an executive of the account's legal entity. By default, it is set to false.

phone

object

The stakeholder's phone number.

Show child parameters (2)

addresses

object

Details of stakeholder's address.

Show child parameters (1)

kyc

object

The type of document required to establish the stakeholder's identity.

Show child parameters (1)

notes

object

Contains user-defined fields stored by the partner for reference purposes. It can hold a maximum of 15 key-value pairs, 512 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Fetch All Stakeholders

GET

/v2/accounts/:account_id/stakeholders

Click to copy

Use this endpoint to retrieve the details of all stakeholders for a given account. Know about the

various error responses

for this API.

Is this page helpful?

Path Parameters

account_id

string

The unique identifier of a sub-merchant account generated by Razorpay. For example, acc_GLGeLkU2JUeyDZ.

Response Parameters

id

string

The unique identifier of a stakeholder generated by Razorpay, used to fetch or update a stakeholder. For example, sth_GLGgm8fFCKc92m. Maximum length supported is 18 characters.

percentage_ownership

float

The stakeholder's ownership of the business in percentage. Only two decimal places are allowed. For example, 87.55. The maximum length is 100 characters.

name

string

The stakeholder's name as per the PAN card. The maximum length is 255 characters.

email

string

The stakeholder's email address. The maximum length is:

local part (before @): 64 characters.
domain part (after @): 68 characters.
The total character length supported is 132.

relationship

object

The stakeholder's relationship with the account’s business. The default value is false.

director: This attribute is set to true if the stakeholder is a director of the account's legal entity. By default, it is set to false.
executive: This attribute is set to true if the stakeholder is an executive of the account's legal entity. By default, it is set to false.

phone

object

The stakeholder's phone number.

Show child parameters (2)

addresses

object

Details of stakeholder's address.

Show child parameters (1)

kyc

object

The type of document required to establish the stakeholder's identity.

Show child parameters (1)

notes

object

Contains user-defined fields stored by the partner for reference purposes. It can hold a maximum of 15 key-value pairs, 512 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

Curl

change language

1curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2- X GET https://api.razorpay.com/v2/accounts/acc_GLGeLkU2JUeyDZ/stakeholders   \

Success

1{
2  "entity": "collection",
3  "items": [
4    {
5      "id": "GZ13yPHLJof9IE",
6      "entity": "stakeholder",
7      "relationship": {
8        "director": true
9      },
10      "phone": {
11        "primary": "9000090000",
12        "secondary": "9000090000"
13      },
14      "notes": {
15        "random_key_by_partner": "random_value"
16      },
17      "kyc": {
18        "pan": "AVOPB1111K"
19      },
20      "name": "Gaurav Kumar",
21      "email": "gaurav.kumar@acme.org",
22      "percentage_ownership": 10,
23      "addresses": {
24        "residential": {
25          "street": "506, Koramangala 1st block",
26          "city": "Bengaluru",
27          "state": "Karnataka",
28          "postal_code": "560034",
29          "country": "in"
30        }
31      }
32    }
33  ],
34  "count": 1
35}