Update a Stakeholder

PATCH

/v2/accounts/:account_id/stakeholders/:stakeholder_id

Click to copy

Use this endpoint to update the details of a stakeholder. Know about the

various error responses

for this API.

The information you can update for a stakeholder using the Update a Stakeholder API differs based on the

product activation status

Currently, we do not support making concurrent requests to the following Onboarding APIs including their combination on the same account_id:

Please wait for the response of these APIs before making subsequent requests.

Is this page helpful?

Curl

change language

1curl -u <YOUR_KEY_ID>:<YOUR_KEY_SECRET> \
2-H "Content-Type: application/json" \
3-X PATCH https://api.razorpay.com/v2/accounts/acc_GLGeLkU2JUeyDZ/stakeholders/sth_GOQ4Eftlz62TSL \
4-d '{
5  "percentage_ownership": 20,
6  "name": "Gauri Kumar",
7  "relationship": {
8    "director": false,
9    "executive": true
10  },
11  "phone": {
12    "primary": "9000090000",
13    "secondary": "9000090000"
14  },
15  "addresses": {
16    "residential": {
17      "street": "507, Koramangala 1st block",
18      "city": "Bangalore",
19      "state": "Karnataka",
20      "postal_code": "560035",
21      "country": "IN"
22    }
23  },
24  "kyc": {
25    "pan": "AVOPB1111J"
26  },
27  "notes": {
28    "random_key_by_partner": "random_value2"
29  }
30}'

Success

1{
2  "id": "acc_GP4lfNA0iIMn5B",
3  "type": "standard",
4  "status": "created",
5  "email": "gauri.kumari@example.com",
6  "profile": {
7    "category": "healthcare",
8    "subcategory": "clinic",
9    "addresses": {
10      "registered": {
11        "street1": "507, Koramangala 1st block",
12        "street2": "MG Road-1",
13        "city": "Bengalore",
14        "state": "KARNATAKA",
15        "postal_code": "560034",
16        "country": "IN"
17      }
18    }
19  },
20  "notes": [],
21  "created_at": 1610603081,
22  "phone": "9000090000",
23  "reference_id": "randomId",
24  "business_type": "partnership",
25  "legal_business_name": "Acme Corp",
26  "customer_facing_business_name": "ABCD Ltd"
27}

Path Parameters

account_id

string

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

id

string

The unique identifier of the stakeholder whose details are to be updated. For example, sth_GOQ4Eftlz62TSL

Request Parameters

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.

relationship

boolean

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. Maximum 15 key-value pairs, 512 characters (maximum) each.

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”.

Update a Stakeholder

PATCH

/v2/accounts/:account_id/stakeholders/:stakeholder_id

Click to copy

Use this endpoint to update the details of a stakeholder. Know about the

various error responses

for this API.

The information you can update for a stakeholder using the Update a Stakeholder API differs based on the

product activation status

Currently, we do not support making concurrent requests to the following Onboarding APIs including their combination on the same account_id:

Please wait for the response of these APIs before making subsequent requests.

Is this page helpful?

Path Parameters

account_id

string

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

id

string

The unique identifier of the stakeholder whose details are to be updated. For example, sth_GOQ4Eftlz62TSL

Request Parameters

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.

relationship

boolean

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. Maximum 15 key-value pairs, 512 characters (maximum) each.

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-H "Content-Type: application/json" \
3-X PATCH https://api.razorpay.com/v2/accounts/acc_GLGeLkU2JUeyDZ/stakeholders/sth_GOQ4Eftlz62TSL \
4-d '{
5  "percentage_ownership": 20,
6  "name": "Gauri Kumar",
7  "relationship": {
8    "director": false,
9    "executive": true
10  },
11  "phone": {
12    "primary": "9000090000",
13    "secondary": "9000090000"
14  },
15  "addresses": {
16    "residential": {
17      "street": "507, Koramangala 1st block",
18      "city": "Bangalore",
19      "state": "Karnataka",
20      "postal_code": "560035",
21      "country": "IN"
22    }
23  },
24  "kyc": {
25    "pan": "AVOPB1111J"
26  },
27  "notes": {
28    "random_key_by_partner": "random_value2"
29  }
30}'

Success

1{
2  "id": "acc_GP4lfNA0iIMn5B",
3  "type": "standard",
4  "status": "created",
5  "email": "gauri.kumari@example.com",
6  "profile": {
7    "category": "healthcare",
8    "subcategory": "clinic",
9    "addresses": {
10      "registered": {
11        "street1": "507, Koramangala 1st block",
12        "street2": "MG Road-1",
13        "city": "Bengalore",
14        "state": "KARNATAKA",
15        "postal_code": "560034",
16        "country": "IN"
17      }
18    }
19  },
20  "notes": [],
21  "created_at": 1610603081,
22  "phone": "9000090000",
23  "reference_id": "randomId",
24  "business_type": "partnership",
25  "legal_business_name": "Acme Corp",
26  "customer_facing_business_name": "ABCD Ltd"
27}