Feel free to reach techsupport@surepass.io for any technical support or guidance.
CKYC Generate OTP
Production
https://kyc-api.surepass.app
Production
https://kyc-api.surepass.app
POST
https://kyc-api.surepass.app
CKYC Generate OTP API
Description
client_id from the Search step and the customer's mobile number (used for validation only - the OTP is sent to the number on file in CKYC, not necessarily the number you pass). Returns a download_client_id for the Download step.Key Benefits
client_id + mobile_numberTechnical Implementation
Authentication
All API requests require authentication using a JWT Bearer token:Obtain API Credentials: Register with Surepass to receive your API key. Generate JWT Token: Use your API key to generate a JWT token. Include in Requests: Add the token to the Environment URLs: Sandbox: Production:
1.
2.
3.
Authorization header as Bearer TOKEN.https://sandbox.surepass.iohttps://kyc-api.surepass.ioRequest Parameters
Request Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | JWT Bearer token for API authentication |
| Content-Type | Yes | Must be set to application/json |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | String | Yes | client_id from the Search response |
| mobile_number | String | Yes | 10-digit mobile number for validation. The OTP is sent to the mobile registered in the customer's CKYC record, not this number. This number is used to confirm the customer knows their registered mobile. |
Example Request
{
"client_id": "ckyc_EklilHGggwPXenefi",
"mobile_number": "8939809876"
}Process Response
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| data | Object | Container for response data |
| data.client_id | String | New download_client_id to use for the Download step |
| data.otp_sent | Boolean | Whether the OTP was successfully sent |
| status_code | Integer | HTTP status code (200 for success) |
| success | Boolean | Overall operation success indicator |
| message | String | Human-readable response message |
| message_code | String | Machine-readable message identifier |
Example Successful Response
{
"data": {
"client_id": "ckyc_download_nNfWARdhysddWFiXddXF",
"otp_sent": true
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}Possible Error Responses
Mobile Not Matched
Mobile Not on CKYC Record
Mobile Not Registered
Invalid Client ID
Daily Limit Exceeded
Server Error
{
"data": null,
"status_code": 422,
"success": false,
"message": "Mobile Number not matched with CKYC.",
"message_code": "mobile_number_not_matched"
}Heads Up
mobile_number_not_matched), (2) mobile doesn't exist in CKYC (mobile_does_not_exist_ckyc), and (3) mobile not registered (mobile_not_registered). Handle each appropriately in your UI.Code Samples
cURL
Python
Node.js
Next Steps
download_client_id from this response + the OTP the customer receives to download full KYC dataRequest
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://kyc-api.surepass.app/api/v1/ckyc-v2/generate-otp' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"client_id": "ckyc_EklilHGggwPXenefi",
"mobile_number": "8939809876"
}'Response Response Example
200 - Success Example
{
"data": {
"client_id": "ckyc_download_nNfWARdhysddWFiXddXF",
"otp_sent": true
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}