Define the following query parameters in the URL. client_id mandatory string The unique client identifier. response_type mandatory string Specifies that the application is requesting an authorisation code grant. Possible value is code . redirect_uri mandatory string Callback URL used by Razorpay to redirect after the user approves or denies the authorisation request. The client should whitelist the redirect_uri . scope mandatory string Defines what access your application is requesting from the user. You can request multiple scopes by separating with a space. Possible values: read_only : Provides read access to all resources. All GET API requests. read_write : Provides read and write access to all resources on the API. state mandatory string A random string generated by your service. This parameter helps prevent cross-site request forgery (CSRF) attacks. State validation has to be implemented by your application and should work as described below: Your application should generate a unique random string and save it in the database. Send the random string to Razorpay in the authorisation request in the state parameter. Razorpay sends back the same state value as query params on your redirect URI. In your backend, you validate that the state value stored in your database matches the one you received for the client_id and the user that initiated the authorisation. onboarding_signature conditionally mandatory string This parameter is applicable only for accounts created using KYC pre-fill. Know more about onboarding signature .

Success Response Parameters

We send the following query parameters if the user approves the authorisation request: code URL-encoded authorisation code. You can exchange this code for an access token in the next step. state The value of the state parameter sent in the authorisation request.

Error Response Parameters

Refer to our errors page for the complete list of errors and solutions.

Technology Partners | Integrate with Custom Onboarding SDK

To integrate with Custom Onboarding SDK:

1. Generate Token

You require a bearer token to access onboarding APIs. Below is a sample code to generate a bearer token using Onboarding SDK.

The access_token is valid for 90 days. After your access token expires, you will receive a 4XX error response. Regenerate the access token using your credentials.

2. Create Account and Upload KYC Details

Use onboarding APIs to add KYC details of your clients. You can pre-fill all or a few KYC details using APIs and let the users fill in the remaining on the onboarding form.

Below are the APIs available to onboard clients.

API	Action
Account	Create and update a client account. Add basic details like name, phone number, email ID and KYC details like business name, type and business PAN details. Check the Account API Entity for the complete list of fields.
Product Configuration	Configure products for an account. Update payment methods, settlement details and refund settings. Check the Product Configuration API Entity for the complete list of fields.
Stakeholder	Add the KYC details of the authorised signatory or the owner of the business. Check the Stakeholder API Entity for the list of fields.
Document	Upload KYC documents for accounts and stakeholders. Know more about Document APIs .

2.1 Create Account

Below is a sample code to create a client account. Know more about

Account APIs

curl --location 'https://api.razorpay.com/v2/accounts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <access_token>' \
-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": "Kormangala",
        "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"
      }
    ]
  }
}'

Account API Entity

string The unique identifier of a sub-merchant account generated by Razorpay. The maximum length is 18 characters. For example, acc_GLGeLkU2JUeyDZ.

type

string The account type. Possible value is standard.

status

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.

string The sub-merchant's business email address.

phone

integer The sub-merchant's business phone number. The minimum length is 8 characters and the maximum length is 15.

legal_business_name

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.

customer_facing_business_name

string The sub-merchant billing label as it appears on the Razorpay 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.

business_type

string The type of business operated by the sub-merchant. Possible values:

Business Types

reference_id

string Partner's external account reference id. The minimum length is 1 character and the maximum length is 512.

profile

object The business details of the sub-merchant's account.

2.2 Request Product Configuration

You can request a product configuration to configure and activate Razorpay products for a client account according to their requirements. Know more about

Product Configuration APIs

Below is a sample code to request a product configuration.

Product Configuration API Entity

string The unique identifier of a product generated by Razorpay for a sub-merchant account. This id is used to fetch or update a product.

product_name

string The product(s) to be configured. Possible values:

payment_gateway
payment_links

tnc

object It consists of the configuration for the accepted terms and conditions by the merchant for the requested product. If the terms and conditions are accepted by the user for the requested product, it would consist of the following fields:

string The unique identifier representing the acceptance of terms and conditions for a product by a user.

accepted

boolean The flag that represents whether the terms and conditions are accepted by the user.

accepted_at

integer The Unix timestamp at which the terms and conditions were accepted by the user for the requested product.

activation_status

string The status of the

product activation

requested
needs_clarification
under_review
activated
suspended

configuration

object The following are the possible configurations:

payment_methods

object