KYC API Documentation

Integrate CGPEY KYC APIs (Aadhaar, PAN, Bank) into your application using merchantId, apiKey and secretKey.

All endpoints are JSON based and should be called from your backend server only (never from browsers or mobile apps directly).

Authentication

Each KYC request must include:

  • merchantId in the JSON body.
  • API credentials in headers (set by CGPEY):
    • x-api-key = your API key
    • x-api-secret = your secret key
Aadhaar OTP Generate

Step 1: Generate an OTP on customer's Aadhaar-linked mobile number.

Endpoint

POST https://docs.cgpey.com/api/kyc/aadhaar/generate-otp

Headers

Content-Type: application/json
x-api-key: YOUR_API_KEY
x-api-secret: YOUR_SECRET_KEY

Request Body

{
  "merchantId": "YOUR_MERCHANT_ID",
  "aadhaarNumber": "123412341234"
}

Success Response (example)

{
  "success": true,
  "message": "OTP sent successfully",
  "data": {
    "requestId": "KASHI_REQ_ID",
    "message": "OTP sent"
  }
}
Aadhaar OTP Verify & KYC

Step 2: Verify OTP and fetch Aadhaar KYC details. This call also records a KYC transaction and deducts wallet balance.

Endpoint

POST https://docs.cgpey.com/api/kyc/aadhaar/verify-otp

Headers

Content-Type: application/json
x-api-key: YOUR_API_KEY
x-api-secret: YOUR_SECRET_KEY

Request Body

{
  "merchantId": "YOUR_MERCHANT_ID",
  "aadhaarNumber": "123412341234",
  "otp": "123456"
}