CKYC Verification

This API is used to search the CKYC registry for individual records using a specific identifier. It returns a client_id, a list of matched records, and the total record count.

The API automatically normalizes the id_type, validates the identifier, and returns results in an array-based structure.

Request Body Parameters:

→ id_type (required): Identifier type used for CKYC search. Send one of the lowercase values listed below exactly as shown; any other value, including a different letter case, is rejected with 400.

→ id_number (required): The identifier value for the selected id_type. Its format is checked against the id_type (see the format listed against each value below); a mismatch is rejected with 400.

Supported id_type Values:

→ passport: Passport number, 1 letter followed by 7 digits (A1234567)

→ voter_id: Voter ID (EPIC), 3 letters followed by 7 digits

→ pan: PAN, 10 characters in the format AAAAA9999A (e.g., ABCDE1234F)

→ driving_license: Driving licence number, 2-letter state code followed by 13 digits (15 characters)

→ aadhaar_proof: Aadhaar number, exactly 12 digits

→ nrega_job_card: NREGA job card number, 5 to 30 characters (letters, digits, hyphen, slash)

→ npr_letter: NPR letter number, 5 to 20 letters or digits

→ ckyc_number: CKYC number, exactly 14 digits

→ ckyc_reference_id: CKYC reference ID, exactly 14 letters or digits (usually starts with IN)

→ mobile_number: Registered mobile number, exactly 10 digits

Important Notes:

→ id_type is case-sensitive. Values such as "PAN" or "Driving License" are not accepted; use "pan" or "driving_license".

→ consent and consent_text are also required (send "Y" and the standard consent text); request_id is optional.

Flow:

1. Call this API with id_type and id_number.

2. Review the returned records array.

3. Select the correct record.

4. Use its ckyc_identifier to initiate the download API.

Initiate an individual CKYC download. This endpoint validates the selected ckyc_identifier and registered mobile_number, then asks CKYC to send an OTP to the registered mobile number.

Use this endpoint after POST api/v1/ckyc/search/individual. The search response gives you records[].ckyc_identifier; pass that value here.

The important continuation value is data.request_id. Store it and use it with POST api/v1/ckyc/download/individual to submit the OTP or request an OTP resend. The client_id is a transaction identifier.

Request Body Parameters:

→ ckyc_identifier (required): CKYC identifier from search. Exactly 14 letters or digits: a CKYC reference ID such as INRMFE49270123 or a 14-digit CKYC number, depending on what search returned.

→ mobile_number (required): 10-digit mobile number registered with the individual CKYC record.

Complete an individual CKYC download after OTP initiation. Use this endpoint in one of two modes:

→ Submit the OTP with request_id and otp.

→ Request another OTP with request_id and resend: true.

The request_id comes from POST api/v1/ckyc/download/individual/initiate. Do not use client_id for OTP submission.

When OTP validation succeeds, the response status is downloaded and data.ckyc_download_data contains the CKYC record.

Request Body Parameters:

→ request_id (required): CKYC request ID returned by the initiate endpoint (data.request_id). Digits only.

→ otp (conditional): Required when you are submitting an OTP (omit when resend is true). Exactly 6 digits, received on the registered mobile number.

→ resend (conditional): Required (as true) when you are requesting another OTP instead of submitting one. Boolean.

Provide either otp or resend: true, not both. A request with neither value is rejected.