Stakeholder APIs

Use the Stakeholders APIs to add stakeholders for an account.


You can use the Stakeholders APIs to add a stakeholder for an account. Each stakeholder will have their KYC.

Handy Tips

A stakeholder can be a signatory or an owner of the business.

Explore the Stakeholder API collection in the Razorpay Postman Public Workspace. Fork the workspace and test the APIs with your

.

API EndpointDescription
Creates a stakeholder.
Retrieves the details of a stakeholder.
Retrieves the details of all stakeholders.
Updates a stakeholder.
Check the before using this API.

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.

entity

string Here it is stakeholder.

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.

primary

integer The primary contact number of the stakeholder. The minimum length is 8 characters and the maximum length is 11.

secondary

integer The secondary contact number of the stakeholder. The minimum length is 8 characters and the maximum length is 11.

addresses

object Details of stakeholder's address.

residential

string Details of the stakeholder's residential address.

street

string The stakeholder's street address. The minimum length is 10 characters and maximum length is 255.

city

string The city. The minimum length is 2 and maximum length is 32.

state

string The state. The minimum length is 2 and maximum length is 32.

postal_code

string The postal code. The minimum length is 2 and maximum length is 10.

country

string The country. The minimum length is 2 and maximum length is 64. This can either be a country code in capital letters or the full name of the country in lower case letters. For example, for India, you must write either IN or india.

.

kyc

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

pan

string The PAN number of the stakeholder.

  • This is a 10-digit alphanumeric code. For example, AVOPB1111K.
  • Regex to validate Stakeholder PAN: /^[a-zA-z]{5}\d{4}[a-zA-Z]{1}$/
  • Validation for Stakeholder PAN: The 4th digit should be 'P'.
  • If the business type is HUF, the karta's PAN should be provided.

Handy Tip

To complete the KYC process, this API parameter might be required, but it is optional for this API.

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

Activation StatusUpdate Permitted
requestedYou can update the details for all the fields.
needs_clarificationThe fields you can update depend on the reason_code mentioned in the requirements object in the :
  • document_missing or field_missing: You can update all the fields.
  • needs_clarification: You can update only the specific field for which Razorpay is seeking clarification for.
under_reviewYou cannot update any fields.
activatedYou cannot use this API to update any fields as your account is already active.

Was this page helpful?