Feel free to reach techsupport@surepass.io for any technical support or guidance.
CKYC Individual Download Initiate
Production
https://kyc-api.surepass.app
Production
https://kyc-api.surepass.app
POST
https://kyc-api.surepass.app
Description
1.
2.
3.
client_id that must be used in the subsequent OTP verification/download step to complete the process.Key Benefits
Technical Implementation
Authentication
All API requests require authentication using a JWT Bearer token. You must obtain a valid JWT token from SurePass and include it in the Sandbox Environment: Use the token issued for your sandbox account against the sandbox base URL. Production Environment: Use the token issued for your production account against the production base URL.
Authorization header of every request.| Environment | Base URL |
|---|---|
| Sandbox | https://sandbox.surepass.app |
| Production | https://kyc-api.surepass.app |
Request Parameters
Request Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer token for authentication. Format: Bearer <your_jwt_token> |
Content-Type | Yes | Must be set to application/json |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
ckyc_identifier | string | Yes | The 14-digit unique CKYC identification number assigned to the individual by CERSAI. Example: "12345678901234" |
mobile_number | string | Yes | The 10-digit mobile number registered with the individual's CKYC record. The OTP will be sent to this number. Example: "9876543210" |
Example Request
{
"ckyc_identifier": "12345678901234",
"mobile_number": "9876543210"
}Process Response
Response Parameters
| Parameter | Type | Description |
|---|---|---|
success | boolean | Indicates whether the API call was successful (true or false). |
status_code | integer | HTTP status code of the response (e.g., 200 for success). |
message | string | A human-readable message describing the result of the API call. |
message_code | string | A machine-readable code representing the result status (e.g., "success"). |
data | object | The response payload containing the initiation details. |
data.client_id | string | A unique identifier for this CKYC download session. This value must be stored and passed to the subsequent OTP verification/download endpoint. |
data.request_id | string | A unique request identifier generated by the system for tracking and audit purposes. |
data.status | string | The current status of the download initiation request. See the status table below. |
Possible status Values
| Status | Meaning |
|---|---|
otp_sent | OTP was successfully sent to the registered mobile number. Proceed to the OTP verification step. |
otp_resent | A fresh OTP was sent (e.g., when re-initiating a request for the same session). |
downloaded | Download completed and ckyc_download_data is present in the response. This may occur if a valid session already exists. |
Example Successful Response
{
"data": {
"client_id": "ckyc_realtime_individual_download_NXwKaQ",
"request_id": "18454383",
"status": "otp_sent"
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}Code Samples
cURL
Python
Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://kyc-api.surepass.app/api/v1/ckyc/v3/download/individual/initiate' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"ckyc_identifier": "12345678901234",
"mobile_number": "9876543210"
}'Response Response Example
{
"data": {
"client_id": "ckyc_realtime_individual_download_NXwKaQ",
"request_id": "18451234",
"status": "otp_sent"
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}