BC Agent Onboarding

POST

/api/v1/nsdl-payment-bank/onboarding

📥 BC Agent Onboarding

Register a Business Correspondent (BC) so they can initiate NSDL account workflows. Captures KYC and contact details and returns a reference for verification and activation.

Purpose: Enable an agent to operate NSDL account journeys.

Output: onboardingId and status (e.g., PENDING_VERIFICATION/APPROVED).

⚠️ Important Notes (Read Carefully)

This API must be called only one time for API Users

On success, the response returns an Agent ID

The generated Agent ID must be stored securely

The same Agent ID must be passed in the Create Account API

Do not call this onboarding API again for the same api merchant
Calling it again will generate a new Agent ID, which may cause data mismatch or failures

🔄 API Flow

Call BC Agent Onboarding API

Receive agent_id in the success response

Use the same agent_id in Create Account API

Reuse the same agent_id in all future agent-related APIs

Request

Header Params

Body Params application/json

Example

{
        "shop_name": "Shop name",
        "name": "Test Name",
        "email": "test@gmail.com",
        "mobile": "9999999999",
        "dob": "1999-01-01",
        "address": "Test Address",
        "state": "Kolkata",
        "city": "Hoogly",
        "pincode": "342001",
        "pancard": "ABCPL9909L"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/nsdl-payment-bank/onboarding' \
--header 'Accept: application/json' \
--header 'x-client-id: {{client_id}}' \
--header 'x-client-secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
        "shop_name": "Shop name",
        "name": "Test Name",
        "email": "test@gmail.com",
        "mobile": "9999999999",
        "dob": "1999-01-01",
        "address": "Test Address",
        "state": "Kolkata",
        "city": "Hoogly",
        "pincode": "342001",
        "pancard": "ABCPL9909L"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "response_code": 200,
    "status": "success",
    "message": "Agent verified successfully..!! Now you can create your agent account.",
    "data": {
        "bc_agentid": "IMBAGT0001",
        "request_id": "IMBNSDLAGNT22530020250905_003a30fe"
    },
    "meta": {
        "request_id": "18318b29-6538-4ab5-931e-55d01191ad42",
        "time": "2025-09-05T22:53:02+05:30"
    }
}

🟠422Parameter Error

🟠400Bad Request

GSTIN Verification

Create Account

BC Agent Onboarding