> ## Documentation Index
> Fetch the complete documentation index at: https://doc-test-my.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Account Entity

> Entity parameters and sample code for Accounts API.

The Account entity has the following parameters:

<ResponseExample>
  ```json Entity theme={null}
  {
    "id": "acc_GRWKk7qQsLnDjX",
    "type": "standard",
    "email": "gauri.kumar@example.org",
    "activated_at": null,
    "live": false,
    "hold_funds": true,
    "status": "created",
    "profile": {
      "category": "healthcare",
      "subcategory": "clinic",
      "addresses": {
        "registered": {
          "street1": "507, Koramangala 1st block",
          "street2": "MG Road",
          "city": "Bengaluru",
          "state": "KARNATAKA",
          "postal_code": 560034,
          "country": "IN"
        },
        "operation": {
          "street1": "507, Koramangala 6th block",
          "street2": "Kormanagala",
          "city": "Bengaluru",
          "state": "KARNATAKA",
          "country": "IN",
          "postal_code": 560047
        }
      },
      "business_model": "Online Clothing ( men, women, ethnic, modern ) fashion and lifestyle, accessories, t-shirt, shirt, track pant, shoes."
    },
    "notes": {
      "internal_ref_id": "123123"
    },
    "created_at": 1611136837,
    "phone": "9999999998",
    "business_type": "partnership",
    "legal_business_name": "Acme Corp",
    "customer_facing_business_name": "Example",
    "legal_info": {
      "pan": "AAACL1234C",
      "gst": "18AABCU9603R1ZM"
    },
    "apps": {
      "websites": [
        "https://www.example.org"
      ],
      "android": [
        {
          "url": "playstore.example.org",
          "name": "Example"
        }
      ],
      "ios": [
        {
          "url": "appstore.example.org",
          "name": "Example"
        }
      ]
    },
    "brand": {
      "color": "#FFFFFF"
    },
    "contact_name": "Gaurav Kumar",
    "contact_info": {
      "chargeback": {
        "email": "cb@example.org",
        "phone": null,
        "policy_url": null
      },
      "refund": {
        "email": "cb@example.org",
        "phone": null,
        "policy_url": null
      },
      "support": {
        "email": "support@example.org",
        "phone": "9999999998",
        "policy_url": "https://www.google.com"
      }
    }
  }
  ```
</ResponseExample>

<ResponseField name="id" type="string">
  The unique identifier of a sub-merchant account generated by Razorpay. The maximum length is 18 characters. For example, `acc_GLGeLkU2JUeyDZ`.
</ResponseField>

<ResponseField name="type" type="string">
  The account type. Possible value is `standard`.
</ResponseField>

<ResponseField name="status" type="string">
  The status of the account. Possible values:

  * `created`: Account status when the merchant account is created.
  * `activated`: Account status when the merchant KYC is approved.
  * `needs_clarification`: Account status when the merchant is asked to provide clarifications related to the KYC details submitted.
  * `under_review`: Account status when the merchant submits all the KYC requirements.
  * `suspended`: Account status when the merchant account is identified as potentially fraudulent and is suspended.
  * `rejected`: Account status when the KYC details submitted by the merchant are rejected during manual review.
</ResponseField>

<ResponseField name="email" type="string">
  The sub-merchant's business email address.
</ResponseField>

<ResponseField name="phone" type="integer">
  The sub-merchant's business phone number. The minimum length is 8 characters and the maximum length is 15.
</ResponseField>

<ResponseField name="legal_business_name" type="string">
  The name of the sub-merchant's business. For example, `Acme Corp`. The minimum length is 4 characters and the maximum length is 200.
</ResponseField>

<ResponseField name="customer_facing_business_name" type="string">
  The sub-merchant billing label as it appears on the Dashboard. The minimum length is 1 character and the maximum length is 255. This parameter might be required to complete the KYC process. However, it is optional for this API.
</ResponseField>

<ResponseField name="business_type" type="string">
  The type of business operated by the sub-merchant. Possible values: [Business Types](/docs/partners/aggregators/onboarding-api/appendix).
</ResponseField>

<ResponseField name="reference_id" type="string">
  Partner's external account reference id. The minimum length is 1 character and the maximum length is 512.
</ResponseField>

<ResponseField name="profile" type="object">
  The business details of the sub-merchant's account.
</ResponseField>

<ResponseField name="category" type="string">
  The business category of the sub-merchant. Possible values: [Business Category](/docs/partners/aggregators/onboarding-api/appendix#business-category)
</ResponseField>

<ResponseField name="subcategory" type="string">
  The business sub-category of the sub-merchant. Possible values: [Business Sub-Category](/docs/partners/aggregators/onboarding-api/appendix#business-sub-category)
</ResponseField>

<ResponseField name="description" type="string">
  This parameter has been deprecated. Pass the description using the `business_model` parameter.
</ResponseField>

<ResponseField name="business_model" type="string">
  The business description. The minimum length is 1 character and the maximum length is 255.
</ResponseField>

<ResponseField name="addresses" type="object">
  Details of sub-merchant's address.<br />
</ResponseField>

<ResponseField name="operation" type="object">
  Details of the sub-merchant's operational address. This parameter might be required to complete the KYC process. However, it is optional for this API.
</ResponseField>

<ResponseField name="street1" type="string">
  Address, line 1. The maximum length is 100 characters.
</ResponseField>

<ResponseField name="street2" type="string">
  Address, line 2. The maximum length is 100 characters.
</ResponseField>

<ResponseField name="city" type="string">
  The city. The maximum length is 100 characters.
</ResponseField>

<ResponseField name="state" type="string">
  The state. The minimum length is 2 and the maximum length is 100.
</ResponseField>

<ResponseField name="postal_code" type="integer">
  The postal code. This should be exactly 6 characters.
</ResponseField>

<ResponseField name="country" type="string">
  The country. The minimum length is 2 and the 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`. [List of supported Countries](/docs/partners/aggregators/onboarding-api/appendix#country-list).
</ResponseField>

<ResponseField name="registered" type="object">
  Details of the sub-merchant's registered address.
</ResponseField>

<ResponseField name="street1" type="string">
  Address, line 1. The maximum length is 100 characters.
</ResponseField>

<ResponseField name="street2" type="string">
  Address, line 2. The maximum length is 100 characters.
</ResponseField>

<ResponseField name="city" type="string">
  The city. The maximum length is 100 characters.
</ResponseField>

<ResponseField name="state" type="string">
  The state. The minimum length is 2 and the maximum length is 100.
</ResponseField>

<ResponseField name="postal_code" type="integer">
  The postal code. This should be exactly 6 characters.
</ResponseField>

<ResponseField name="country" type="string">
  The country. The minimum length is 2 and the 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`. [List of supported Countries](/docs/partners/aggregators/onboarding-api/appendix#country-list).
</ResponseField>

<ResponseField name="legal_info" type="object">
  The legal details about the sub-merchant's business.
</ResponseField>

<ResponseField name="pan" type="string">
  Valid PAN number details of the sub-merchant's business.

  * This is a 10-digit alphanumeric code. For example, `AVOJB1111K`.
  * The 4th digit should be either of 'C', 'H', 'F', 'A', 'T', 'B', 'J', 'G', 'L'.
  * The regex for Company PAN is `/^[a-zA-z]{5}\d{4}[a-zA-Z]{1}$/`.<br />
    This parameter might be required to complete the KYC process. However, it is optional for this API. Business types like proprietorship and individual (`not_yet_registered`), do not require Business PAN.
</ResponseField>

<ResponseField name="gst" type="string">
  Valid GSTIN number details of the sub-merchant.

  * This is a 15-digit PAN-based unique identification number.
  * The Regex for GSTIN is `/^[0123][0-9][a-z]{5}[0-9]{4}[a-z][0-9][a-z0-9][a-z0-9]$/gi`.
</ResponseField>

<ResponseField name="cin" type="string">
  CIN is for Private Limited and Public Limited, whereas LLPIN is for LLP business type.

  * This is a 21-digit alpha-numeric number.
  * The Regex for CIN is `/^([a-z]{3}-\d{4}|[ul]\d{5}[a-z]{2}\d{4}[a-z]{3}\d{6})$/i`.
</ResponseField>

<ResponseField name="brand" type="object">
  The branding details of the sub-merchant's business.
</ResponseField>

<ResponseField name="color" type="string">
  The color code of sub-merchant's business brand. This is a 6-character hex code (Regex: \[a-fA-F0-9]\{6}).
</ResponseField>

<ResponseField name="notes" type="object">
  Contains user-defined fields stored by the partner for reference purposes.
</ResponseField>

<ResponseField name="contact_name" type="string">
  The name of the contact. The minimum length is 4 and the maximum length is 255 characters.
</ResponseField>

<ResponseField name="contact_info" type="object">
  Options available for contact support.
</ResponseField>

<ResponseField name="chargeback" type="object">
  The type of contact support.
</ResponseField>

<ResponseField name="email" type="string">
  The email id of chargeback POC. The maximum length is:

  * local part (before @): 64 characters.
  * domain part (after @): 68 characters. <br /> The total character length supported is 132.
</ResponseField>

<ResponseField name="phone" type="integer">
  The phone number of chargeback POC. The maximum length is 10 characters.
</ResponseField>

<ResponseField name="policy_url" type="string">
  The URL of chargeback policy. Regex is (protocol://`razorpay.com`:port/resource path?querystring#fragementid)<br /> protocol-both http/https allowed. Only domain name is mandatory.
</ResponseField>

<ResponseField name="refund" type="object">
  The type of contact support.
</ResponseField>

<ResponseField name="email" type="string">
  The email id of refund POC. The maximum length is:

  * local part (before @): 64 characters.
  * domain part (after @): 68 characters. <br /> The total character length supported is 132.
</ResponseField>

<ResponseField name="phone" type="integer">
  The phone number of refund POC. The maximum length is 10 characters.
</ResponseField>

<ResponseField name="policy_url" type="string">
  The URL of refund policy. Regex is (protocol://`razorpay.com`:port/resource path?querystring#fragementid) <br /> protocol-both http/https allowed.
</ResponseField>

<ResponseField name="support" type="array">
  The type of contact support.
</ResponseField>

<ResponseField name="email" type="string">
  The email id of support POC. The maximum length is:

  * local part (before @): 64 characters.
  * domain part (after @): 68 characters. <br /> The total character length supported is 132.
</ResponseField>

<ResponseField name="phone" type="integer">
  The phone number of support POC. The maximum length is 10 characters.
</ResponseField>

<ResponseField name="policy_url" type="string">
  The URL of support policy. Regex is (protocol://`razorpay.com`:port/resource path?querystring#fragementid) <br /> protocol-both http/https allowed.
</ResponseField>

<ResponseField name="apps" type="object">
  The app details of the sub-merchant's business
</ResponseField>

<ResponseField name="websites" type="array">
  The website/app for the sub-merchant's business. A minimum of 1 website is required.
</ResponseField>

<ResponseField name="android" type="array">
  Android app details
</ResponseField>

<ResponseField name="url" type="string">
  The link of the Android app. Regex is (protocol://`razorpay.com`:port/resource path?querystring#fragementid) <br /> protocol-both http/https allowed.
</ResponseField>

<ResponseField name="name" type="string">
  The name of the Android app.
</ResponseField>

<ResponseField name="ios" type="array">
  iOS app details
</ResponseField>

<ResponseField name="url" type="string">
  The link of the iOS app. Regex is (protocol://`razorpay.com`:port/resource path?querystring#fragementid) <br /> protocol-both http/https allowed.
</ResponseField>

<ResponseField name="name" type="string">
  The name of the iOS app.
</ResponseField>

<ResponseField name="activated_at" type="integer">
  Unix timestamp that indicates when the merchant account was activated. This parameter has `null` value till the account is activated.
</ResponseField>

<ResponseField name="live" type="boolean">
  Indicates the payments acceptance status of the merchant account. Possible values:

  * `true`:  Merchant can start accepting customer payments.
  * `false`: Merchant cannot accept customer payments.
</ResponseField>

<ResponseField name="hold_funds" type="boolean">
  Indicates the settlements status of the merchant account. Possible values:

  * `true`:  Settlement are on hold. Funds are not transferred to the merchant account.
  * `false`: Settlements can be transferred to the merchant account.
</ResponseField>