CKYC Update Status

Endpoint Overview

POST /api/v1/ckyc-upload/update/status

Description

This API endpoint allows you to check the status of a CKYC (Central KYC) update request that was previously initialized. By providing the unique client_id associated with the CKYC update session, you can retrieve the current processing state, approval status, and individual file responses for each person included in the update. This helps organizations track the progress of CKYC updates and take timely action based on the status.

Key Benefits

Enables real-time tracking of CKYC update requests.

Provides granular status for each individual in a bulk update.

Reduces manual follow-ups and operational delays.

Enhances transparency and compliance in KYC workflows.

Use Cases

Banking & Financial Services

NBFCs & Lending

Insurance & Mutual Funds

Monitor the status of bulk CKYC updates for customer onboarding.

Track pending, approved, or rejected KYC updates for regulatory compliance.

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

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 Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token in the format `Bearer <JWT>`
Content-Type	Yes	`application/json`

Request Body

Parameter	Type	Required	Description
client_id	string	Yes	Unique client identifier for the CKYC update session.

Example Request

{
  "client_id": "ckyc_update_kjihrpwyigtauuercgGv"
}

Process Response

Response Parameters

Parameter	Type	Description
data	object	Main response payload.
data.client_id	string	Unique client identifier for the CKYC update session.
data.state	string	State of the CKYC update (e.g., "pending", "approved", "rejected").
data.response	object	Detailed response for the update session.
data.response.approved_by_checker	boolean	Indicates if the update was approved by the checker.
data.response.individual_file_response	array	List of status responses for each individual in the update.
data.response.individual_file_response[].identifier	string	Identifier for the individual (e.g., CKYC number).
data.response.individual_file_response[].message	string/null	Status message for the individual (if any).
data.response.individual_file_response[].status	string	Status for the individual (e.g., "pending", "approved", "rejected").
status_code	number	HTTP status code (e.g., 200 for success).
success	boolean	Indicates if the request was successful.
message	string	Human-readable status message.
message_code	string	Machine-readable status code.

Example Successful Response

{
  "data": {
    "client_id": "ckyc_update_kjihrpwyigtauuercgGv",
    "state": "pending",
    "response": {
      "approved_by_checker": false,
      "individual_file_response": [
        {
          "identifier": "78945612378901",
          "message": null,
          "status": "pending"
        }
      ]
    }
  },
  "status_code": 200,
  "success": true,
  "message": "Success",
  "message_code": "success"
}

Possible Error Responses

Invalid or Missing Token

Invalid client_id

Internal Server Error

{
  "status_code": 401,
  "success": false,
  "message": "Unauthorized: Invalid or missing token",
  "message_code": "unauthorized"
}

The request is missing a valid Bearer token or the token is invalid.

Integration Best Practices

Security Recommendations

Always use HTTPS to protect sensitive KYC data in transit.

Store JWT tokens securely and rotate them periodically.

Never expose your API keys or tokens in client-side code or public repositories.

User Experience Guidelines

Display clear and actionable status messages to users.

Allow users to retry or escalate if a status remains pending for too long.

Code Samples

cURL

Python

Node.js

Related APIs

CKYC Update Initialize API: To start a new CKYC update session.

CKYC Upload API: For bulk or single CKYC data uploads.

CKYC Download API: To retrieve CKYC data for individuals.

Compliance and Legal Considerations

Ensure all CKYC data status checks comply with regulatory requirements and data privacy laws. Only authorized personnel should have access to KYC data. Securely store and transmit sensitive information, and never share JWT tokens or personal data in unsecured channels.

This documentation provides a comprehensive, implementation-focused guide for integrating the CKYC Update Status API into your applications. For further support, refer to Surepass developer resources or contact your Surepass representative.

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/ckyc-upload/update/status' \ --header 'Content-Type: application/json' \ --data-raw '{ "client_id": "ckyc_update_kjihrpwyigtauuercgGv" }'

{ "data": { "client_id": "ckyc_update_kjihrpwyigtauuercgGv", "state": "pending", "response": { "approved_by_checker": false, "individual_file_response": [ { "identifier": "78945612378901", "message": null, "status": "pending" } ] } }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

CKYC Update Status

CKYC Update Status#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

CKYC Update Status

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples