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

# Create an Account

> Onboard sub-merchants by creating an account using Razorpay Partners APIs.

Use this endpoint to create an account.

<RequestExample>
  ```bash Curl theme={null}
  curl -X POST https://api.razorpay.com/v2/accounts \
  -u <ACCESS_TOKEN> \
  -H "Content-Type: application/json" \
  -d '{
    "email": "gauriagain.kumar@example.org",
    "phone": "9000090000",
    "legal_business_name": "Acme Corp",
    "business_type": "partnership",
    "customer_facing_business_name": "Example",
    "profile": {
      "category": "healthcare",
      "subcategory": "clinic",
      "description": "Healthcare E-commerce platform",
      "addresses": {
        "operation": {
          "street1": "507, Koramangala 6th block",
          "street2": "Kormanagala",
          "city": "Bengaluru",
          "state": "Karnataka",
          "postal_code": 560047,
          "country": "IN"
        },
        "registered": {
          "street1": "507, Koramangala 1st block",
          "street2": "MG Road",
          "city": "Bengaluru",
          "state": "Karnataka",
          "postal_code": 560034,
          "country": "IN"
        }
      },
      "business_model": "Online Clothing ( men, women, ethnic, modern ) fashion and lifestyle, accessories, t-shirt, shirt, track pant, shoes."
    },
    "legal_info": {
      "pan": "AAACL1234C",
      "gst": "18AABCU9603R1ZM"
    },
    "brand": {
      "color": "FFFFFF"
    },
    "notes": {
      "internal_ref_id": "123123"
    },
    "contact_name": "Gaurav Kumar",
    "contact_info": {
      "chargeback": {
        "email": "cb@example.org"
      },
      "refund": {
        "email": "cb@example.org"
      },
      "support": {
        "email": "support@example.org",
        "phone": "9999999998",
        "policy_url": "https://www.google.com"
      }
    },
    "apps": {
      "websites": [
        "https://www.example.org"
      ],
      "android": [
        {
          "url": "playstore.example.org",
          "name": "Example"
        }
      ],
      "ios": [
        {
          "url": "appstore.example.org",
          "name": "Example"
        }
      ]
    }
  }'
  ```

  ```java Java theme={null}
  RazorpayClient razorpay = new RazorpayClient("[ACCESS_TOKEN]");

  JSONObject accountRequest = new JSONObject();
  accountRequest.put("email","gauriagain.kumar@example.org");
  accountRequest.put("phone","9000090000");
  accountRequest.put("legal_business_name","Acme Corp");
  accountRequest.put("business_type","partnership");
  accountRequest.put("customer_facing_business_name","Example");
  JSONObject profile = new JSONObject();
  profile.put("category","healthcare");
  profile.put("subcategory","clinic");
  profile.put("description","Healthcare E-commerce platform");

  JSONObject operation = new JSONObject();
  operation.put("street1","507, Koramangala 6th block");
  operation.put("street2","507, Koramangala");
  operation.put("city","Bengaluru");
  operation.put("state","Karnataka");
  operation.put("postal_code","560047");
  operation.put("country","IN");

  JSONObject registered = new JSONObject();
  registered.put("street1","507, Koramangala 1th block");
  registered.put("street2","MG Road");
  registered.put("city","Bengaluru");
  registered.put("state","Karnataka");
  registered.put("postal_code","560034");
  registered.put("country","IN");

  JSONObject addresses = new JSONObject();
  addresses.put("operation",operation);
  addresses.put("registered",registered);

  profile.put("addresses",addresses);
  profile.put("business_model","Online Clothing ( men, women, ethnic, modern ) fashion and lifestyle, accessories, t-shirt, shirt, track pant, shoes.");

  JSONObject legalInfo = new JSONObject();
  legalInfo.put("pan","AAACL1234C");
  legalInfo.put("gst","18AABCU9603R1ZM");

  accountRequest.put("profile",profile);
  accountRequest.put("legal_info",legalInfo);

  JSONObject brand = new JSONObject();
  brand.put("color","FFFFFF");

  accountRequest.put("brand",brand);

  JSONObject notes = new JSONObject();
  notes.put("internal_ref_id","123123");

  accountRequest.put("notes",notes);
  accountRequest.put("contact_name","Gaurav Kumar");

  JSONObject contactInfo = new JSONObject();
  JSONObject chargeback = new JSONObject();
  chargeback.put("email","cb@example.org");

  JSONObject refund = new JSONObject();
  refund.put("email","cb@example.org");

  JSONObject support = new JSONObject();
  support.put("email","support@example.org");
  support.put("phone","9999999998");
  support.put("policy_url","https://www.google.com");

  contactInfo.put("chargeback",chargeback);
  contactInfo.put("refund",refund);
  contactInfo.put("support",support);
  accountRequest.put("contact_info",contactInfo);

  JSONObject apps = new JSONObject();
  ArrayList<String> url = new ArrayList<String>();
  url.add("https://www.example.org");

  apps.put("websites",url);
  ArrayList<JSONObject> android = new ArrayList<JSONObject>();
  JSONObject android_details = new JSONObject();
  android_details.put("url","playstore.example.org");
  android_details.put("name","Example");

  apps.put("android",android);
  android.add(android_details);
  ArrayList<JSONObject> ios = new ArrayList<JSONObject>();
  JSONObject ios_details = new JSONObject();
  ios_details.put("url","appstore.example.org");
  ios_details.put("name","Example");
  ios.add(ios_details);
  apps.put("android",android);
  apps.put("ios",ios);

  Account account = instance.account.create(accountRequest);
  ```

  ```php PHP theme={null}
  $api = new Api(null, null, "<ACCESS_TOKEN>");

  $api->account->create(array(
     "email" => "gauriagain.kumar@example.org",
     "phone" => "9000090000",
     "legal_business_name" => "Acme Corp",
     "business_type" => "partnership",
     "customer_facing_business_name" => "Example",
     "profile" => array(
         "category" => "healthcare",
         "subcategory" => "clinic",
         "description" => "Healthcare E-commerce platform",
         "addresses" => array(
             "operation" => array(
                 "street1" => "507, Koramangala 6th block",
                 "street2" => "Kormanagala",
                 "city" => "Bengaluru",
                 "state" => "Karnataka",
                 "postal_code" => 560047,
                 "country" => "IN"
             ),
             "registered" => array(
                 "street1" => "507, Koramangala 1st block",
                 "street2" => "MG Road",
                 "city" => "Bengaluru",
                 "state" => "Karnataka",
                 "postal_code" => 560034,
                 "country" => "IN"
             )
         ),
         "business_model" => "Online Clothing ( men, women, ethnic, modern ) fashion and lifestyle, accessories, t-shirt, shirt, track pant, shoes."
     ),
     "legal_info" => array(
         "pan" => "AAACL1234C",
         "gst" => "18AABCU9603R1ZM"
     ),
     "brand" => array(
         "color" => "FFFFFF"
     ),
     "notes" => array(
         "internal_ref_id" => "123123"
     ),
     "contact_name" => "Gaurav Kumar",
     "contact_info" => array(
         "chargeback" => array(
             "email" => "cb@example.org"
         ),
         "refund" => array(
             "email" => "cb@example.org"
         ),
         "support" => array(
             "email" => "support@example.org",
             "phone" => "9999999998",
             "policy_url" => "https://www.google.com"
         )
     ),
     "apps" => array(
         "websites" => array(
             "https://www.example.org"
         ),
         "android" => array(
             array(
                 "url" => "playstore.example.org",
                 "name" => "Example"
             )
         ),
         "ios" => array(
             array(
                 "url" => "appstore.example.org",
                 "name" => "Example"
             )
         )
     )
  ));
  ```

  ```javascript Node.js theme={null}
  const instance = new Razorpay({
    oauthToken: "<ACCESS_TOKEN>"
  );

  instance.accounts.create({
      "email": "gauriagain.kumar@example.org",
      "phone": "9000090000",
      "legal_business_name": "Acme Corp",
      "business_type": "partnership",
      "customer_facing_business_name": "Example",
      "profile": {
        "category": "healthcare",
        "subcategory": "clinic",
        "description": "Healthcare E-commerce platform",
        "addresses": {
          "operation": {
            "street1": "507, Koramangala 6th block",
            "street2": "Kormanagala",
            "city": "Bengaluru",
            "state": "Karnataka",
            "postal_code": 560047,
            "country": "IN"
          },
          "registered": {
            "street1": "507, Koramangala 1st block",
            "street2": "MG Road",
            "city": "Bengaluru",
            "state": "Karnataka",
            "postal_code": 560034,
            "country": "IN"
          }
        },
        "business_model": "Online Clothing ( men, women, ethnic, modern ) fashion and lifestyle, accessories, t-shirt, shirt, track pant, shoes."
      },
      "legal_info": {
        "pan": "AAACL1234C",
        "gst": "18AABCU9603R1ZM"
      },
      "brand": {
        "color": "FFFFFF"
      },
      "notes": {
        "internal_ref_id": "123123"
      },
      "contact_name": "Gaurav Kumar",
      "contact_info": {
        "chargeback": {
          "email": "cb@example.org"
        },
        "refund": {
          "email": "cb@example.org"
        },
        "support": {
          "email": "support@example.org",
          "phone": "9999999998",
          "policy_url": "https://www.google.com"
        }
      },
      "apps": {
        "websites": [
          "https://www.example.org"
        ],
        "android": [
          {
            "url": "playstore.example.org",
            "name": "Example"
          }
        ],
        "ios": [
          {
            "url": "appstore.example.org",
            "name": "Example"
          }
        ]
      }
    })
  ```

  ```ruby Ruby theme={null}
  require "razorpay"
  Razorpay._with_oauth('access_token')
  Razorpay::Account.create({
    "email": "gauriagain.kumar@example.org",
    "phone": "9000090000",
    "legal_business_name": "Acme Corp",
    "business_type": "partnership",
    "customer_facing_business_name": "Example",
    "profile": {
      "category": "healthcare",
      "subcategory": "clinic",
      "description": "Healthcare E-commerce platform",
      "addresses": {
        "operation": {
          "street1": "507, Koramangala 6th block",
          "street2": "Kormanagala",
          "city": "Bengaluru",
          "state": "Karnataka",
          "postal_code": 560047,
          "country": "IN"
        },
        "registered": {
          "street1": "507, Koramangala 1st block",
          "street2": "MG Road",
          "city": "Bengaluru",
          "state": "Karnataka",
          "postal_code": 560034,
          "country": "IN"
        }
      },
      "business_model": "Online Clothing ( men, women, ethnic, modern ) fashion and lifestyle, accessories, t-shirt, shirt, track pant, shoes."
    },
    "legal_info": {
      "pan": "AAACL1234C",
      "gst": "18AABCU9603R1ZM"
    },
    "brand": {
      "color": "FFFFFF"
    },
    "notes": {
      "internal_ref_id": "123123"
    },
    "contact_name": "Gaurav Kumar",
    "contact_info": {
      "chargeback": {
        "email": "cb@example.org"
      },
      "refund": {
        "email": "cb@example.org"
      },
      "support": {
        "email": "support@example.org",
        "phone": "9999999998",
        "policy_url": "https://www.google.com"
      }
    },
    "apps": {
      "websites": [
        "https://www.example.org"
      ],
      "android": [
        {
          "url": "playstore.example.org",
          "name": "Example"
        }
      ],
      "ios": [
        {
          "url": "appstore.example.org",
          "name": "Example"
        }
      ]
    }
  })
  ```

  ```csharp .NET theme={null}
  RazorpayClient client = new RazorpayClient("[ACCESS_TOKEN]");

  Dictionary<string, object> accountRequest = new Dictionary<string, object>();
  accountRequest.Add("email", "gauriagain_n21.kumar@example.org");
  accountRequest.Add("phone", "9000090000");
  accountRequest.Add("legal_business_name", "Acme Corp");
  accountRequest.Add("business_type", "partnership");
  accountRequest.Add("customer_facing_business_name", "Example");
  Dictionary<string, object> profile = new Dictionary<string, object>();
  profile.Add("category", "healthcare");
  profile.Add("subcategory", "clinic");
  profile.Add("description", "Healthcare E-commerce platform");

  Dictionary<string, object> operation = new Dictionary<string, object>();
  operation.Add("street1", "507, Koramangala 6th block");
  operation.Add("street2", "507, Koramangala");
  operation.Add("city", "Bengaluru");
  operation.Add("state", "Karnataka");
  operation.Add("postal_code", "560047");
  operation.Add("country", "IN");

  Dictionary<string, object> registered = new Dictionary<string, object>();
  registered.Add("street1", "507, Koramangala 1th block");
  registered.Add("street2", "MG Road");
  registered.Add("city", "Bengaluru");
  registered.Add("state", "Karnataka");
  registered.Add("postal_code", "560034");
  registered.Add("country", "IN");

  Dictionary<string, object> addresses = new Dictionary<string, object>();
  addresses.Add("operation", operation);
  addresses.Add("registered", registered);

  profile.Add("addresses", addresses);
  profile.Add("business_model", "Online Clothing ( men, women, ethnic, modern ) fashion and lifestyle, accessories, t-shirt, shirt, track pant, shoes.");

  Dictionary<string, object> legalInfo = new Dictionary<string, object>();
  legalInfo.Add("pan", "AAACL1234C");
  legalInfo.Add("gst", "18AABCU9603R1ZM");

  accountRequest.Add("profile", profile);
  accountRequest.Add("legal_info", legalInfo);

  Dictionary<string, object> brand = new Dictionary<string, object>();
  brand.Add("color", "FFFFFF");

  accountRequest.Add("brand", brand);

  Dictionary<string, object> notes = new Dictionary<string, object>();
  notes.Add("internal_ref_id", "123123");

  accountRequest.Add("notes", notes);
  accountRequest.Add("contact_name", "Gaurav Kumar");

  Dictionary<string, object> contactInfo = new Dictionary<string, object>();
  Dictionary<string, object> chargeback = new Dictionary<string, object>();
  chargeback.Add("email", "cb@example.org");

  Dictionary<string, object> refund = new Dictionary<string, object>();
  refund.Add("email", "cb@example.org");

  Dictionary<string, object> support = new Dictionary<string, object>();
  support.Add("email", "support@example.org");
  support.Add("phone", "9999999998");
  support.Add("policy_url", "https://www.google.com");

  contactInfo.Add("chargeback", chargeback);
  contactInfo.Add("refund", refund);
  contactInfo.Add("support", support);
  accountRequest.Add("contact_info", contactInfo);

  Dictionary<string, object> apps = new Dictionary<string, object>();
  List<string> url = new List<string>();
  url.Add("https://www.example.org");

  apps.Add("websites", url);
  Dictionary<string, object> android_details = new Dictionary<string, object>();
  android_details.Add("url", "playstore.example.org");
  android_details.Add("name", "Example");
  List<Dictionary<string, object>> android = new List<Dictionary<string, object>>();
  android.Add(android_details);
  apps.Add("android", android);

  Dictionary<string, object> ios_details = new Dictionary<string, object>();
  ios_details.Add("url", "appstore.example.org");
  ios_details.Add("name", "Example");
  List<Dictionary<string, object>> ios = new List<Dictionary<string, object>>();
  ios.Add(ios_details);
  apps.Add("ios", ios);
  accountRequest.Add("apps", apps);

  Account payment = client.Account.Create(accountRequest);
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "id": "acc_GRWKk7qQsLnDjX",
    "type": "standard",
    "status": "created",
    "email": "gauriagain.kumar@example.org",
    "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": "Kormanagalo",
          "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": "9000090000",
    "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_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>

## Request Parameters

<ParamField body="email" type="string" required>
  The sub-merchant's business email address.
</ParamField>

<ParamField body="phone" type="integer" required>
  The sub-merchant's business phone number, without the country code. The minimum length is 8 characters and the maximum length is 15. For example, `9876543210`.
</ParamField>

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

<ParamField body="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.
</ParamField>

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

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

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

<ParamField body="category" type="string" required>
  The business category of the sub-merchant. Possible values: [List of Business Categories](/docs/partners/aggregators/onboarding-api/appendix#business-category).
</ParamField>

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

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

<ParamField body="business_model" type="string">
  The business description. The character limit between 1-255 characters.
</ParamField>

<ParamField body="addresses" type="object">
  Details of sub-merchant's address.
</ParamField>

<ParamField body="operation" type="object">
  Details of the sub-merchant's operational address.
</ParamField>

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

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

<ParamField body="city" type="string">
  The city. The maximum length is 100 characters.
</ParamField>

<ParamField body="state" type="string">
  The state. The minimum length is 2 and the maximum length is 32.
</ParamField>

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

<ParamField body="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).
</ParamField>

<ParamField body="registered" type="object" required>
  Details of the sub-merchant's registered address.
</ParamField>

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

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

<ParamField body="city" type="string">
  The city. The maximum length is 100 characters.
</ParamField>

<ParamField body="state" type="string">
  The state. The minimum length is 2 and the maximum length is 32.
</ParamField>

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

<ParamField body="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).
</ParamField>

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

<ParamField body="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}$/`.
</ParamField>

<ParamField body="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`
</ParamField>

<ParamField body="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`.
</ParamField>

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

<ParamField body="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}).
</ParamField>

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

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

<ParamField body="contact_info" type="object">
  Options available for contact support.
</ParamField>

<ParamField body="chargeback" type="object">
  The type of contact support.
</ParamField>

<ParamField body="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.
</ParamField>

<ParamField body="phone" type="string">
  The phone number of chargeback POC. The minimum length is 8 and the maximum length is 10 characters.
</ParamField>

<ParamField body="policy_url" type="string">
  The URL of chargeback policy.
</ParamField>

<ParamField body="refund" type="object">
  The type of contact support.
</ParamField>

<ParamField body="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.
</ParamField>

<ParamField body="phone" type="string">
  The phone number of refund POC. The minimum length is 8 and the maximum length is 10 characters.
</ParamField>

<ParamField body="policy_url" type="string">
  The URL of refund policy.
</ParamField>

<ParamField body="support" type="object">
  The type of contact support.
</ParamField>

<ParamField body="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.
</ParamField>

<ParamField body="phone" type="string">
  The phone number of support POC. The minimum length is 8 and the maximum length is 10 characters.
</ParamField>

<ParamField body="policy_url" type="string">
  The URL of support policy.
</ParamField>

<ParamField body="apps" type="object">
  The website/app details of the sub-merchant's business.
</ParamField>

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

<ParamField body="android" type="array">
  Android app details
</ParamField>

<ParamField body="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.
</ParamField>

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

<ParamField body="ios" type="array">
  iOS app details
</ParamField>

<ParamField body="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.
</ParamField>

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

## Response Parameters

<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 to validate 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 to validate 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>