Feel free to reach techsupport@surepass.io for any technical support or guidance.
ckyc_identifier from search plus a valid authentication factor. This flow completes in a single request and does not use OTP.Authorization header of every request.| Environment | Base URL |
|---|---|
| Sandbox | https://sandbox.surepass.app |
| Production | https://kyc-api.surepass.app |
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer token for authentication. Format: Bearer <your_jwt_token> |
Content-Type | Yes | Must be set to application/json |
| Parameter | Type | Required | Description |
|---|---|---|---|
ckyc_identifier | string | Yes | The 14-digit CKYC number of the legal entity, typically obtained from a prior CKYC search operation. |
auth_factor_type | string | Yes | The type of authentication factor used to verify the download request. See the supported values table below. |
auth_factor | string | Yes | The actual value of the chosen authentication factor. The format must correspond to the selected auth_factor_type. |
auth_factor_type Values| Value | Notes |
|---|---|
date_of_incorporation | Date of incorporation of the legal entity (format: YYYY-MM-DD) |
mobile_number | Registered mobile number associated with the entity |
email | Registered email address associated with the entity |
pincode | Registered pincode associated with the entity's address |
auth_factor_type whose corresponding value you have available and that matches the records held in the CKYC registry. The date_of_incorporation is the most commonly used factor for legal entity verification.{
"ckyc_identifier": "22345678901234",
"auth_factor_type": "date_of_incorporation",
"auth_factor": "2019-05-10"
}| Parameter | Type | Description |
|---|---|---|
success | boolean | Indicates whether the API request was successful (true or false). |
status_code | integer | HTTP status code of the response. |
message | string | Human-readable message describing the outcome of the request. |
message_code | string | Machine-readable message code for programmatic handling. |
data | object | Contains the main response payload. |
data.client_id | string | Unique client-side identifier for this download transaction. |
data.status | string | Status of the download operation. See the possible status values table below. |
data.ckyc_download_data | object | The complete downloaded CKYC record of the legal entity. Present when status is downloaded. |
data.ckyc_download_data.record_counts | object | Metadata about CKYC record counts. |
data.ckyc_download_data.record_counts.update_count | integer | Number of updates made to the CKYC record. |
data.ckyc_download_data.record_counts.download_count | integer | Number of times the CKYC record has been downloaded. |
data.ckyc_download_data.personal_details | object | Core identity details of the legal entity. |
data.ckyc_download_data.personal_details.fullname | string | Full registered name of the legal entity. |
data.ckyc_download_data.personal_details.constitution_type | string | Constitution type of the entity (e.g., Private Limited Company, LLP, etc.). |
data.ckyc_download_data.personal_details.ckyc_number | string | The 14-digit CKYC number assigned to the legal entity. |
data.ckyc_download_data.personal_details.ckyc_reference_id | string | The unique CKYC reference identifier for the record. |
data.ckyc_download_data.related_persons | array | List of individuals related to the legal entity (e.g., directors, partners, trustees). |
data.ckyc_download_data.related_persons[].full_name | string | Full name of the related person. |
data.ckyc_download_data.related_persons[].relationship_type | integer | Numeric code representing the relationship type of the person to the entity. |
data.ckyc_download_data.related_persons[].pan | string | PAN number of the related person. |
status Values| Status | Meaning |
|---|---|
downloaded | Download completed successfully and ckyc_download_data is present in the response. |
{
"data": {
"client_id": "ckyc_realtime_legal_download_QxLkPz",
"status": "downloaded",
"ckyc_download_data": {
"record_counts": {
"update_count": 1,
"download_count": 7
},
"personal_details": {
"fullname": "ACME TECHNOLOGIES PRIVATE LIMITED",
"constitution_type": "Private Limited Company",
"ckyc_number": "22345678901234",
"ckyc_reference_id": "LEFILB20063639"
},
"related_persons": [
{
"full_name": "VINEET KAPOOR",
"relationship_type": 4,
"pan": "ABCDE1234F"
}
]
}
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}curl --location --request POST 'https://kyc-api.surepass.app/api/v1/ckyc/v3/download/legal' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"ckyc_identifier": "22345678901234",
"auth_factor_type": "date_of_incorporation",
"auth_factor": "2019-05-10"
}'{
"data": {
"client_id": "ckyc_realtime_legal_download_QxLkPz",
"status": "downloaded",
"ckyc_download_data": {
"record_counts": {
"update_count": 1,
"download_count": 7
},
"personal_details": {
"fullname": "ACME TECHNOLOGIES PRIVATE LIMITED",
"constitution_type": "Private Limited Company",
"ckyc_number": "22345678901234",
"ckyc_reference_id": "LEFILB20063639"
},
"related_persons": [
{
"full_name": "VINEET KAPOOR",
"relationship_type": 4,
"pan": "ABCDE1234F"
}
]
}
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}