BrandKwikID Documentation

CKYC Search

Search the CKYC registry by ID type and number. Server-side POST with Bearer auth.

API reference

Try itLoading playground…
Loading…
AuthorizationBearer <token>

JWT Bearer token authentication. Obtain a token from the KwikID dashboard.

In: header

id_no?string

ID value matching id_type (for example PAN string when id_type is C).

id_type?string

Supported ID Types: A: Passport Number; B: Voter ID; C: PAN; D: Driving License; E: Proof of Possession of Aadhaar (Last 4 digits of Aadhaar number | Applicant Name | DOB Format should be D-MM-YYY | Gender - M/F/T )

Response Body

curl -X POST "https://__mock__/api/ckyc/search" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "detail": {},
  "message": "string"
}
{
  "detail": {},
  "message": "string"
}

Overview

Call POST /api/ckyc/search from your backend with Authorization: Bearer <token> and JSON id_type and id_no. id_type follows the CKYC letter codes in OpenAPI (for example C for PAN). Use the response to obtain a CKYC number for CKYC Download and OTP steps.

Key features

  • Registry-first: Confirms a CKYC record exists before download.
  • Typed IDs: Supports multiple government ID paths per id_type rules in OpenAPI.

Implementation

Step 1: Call from your backend

POST /api/ckyc/search HTTP/1.1
Host: <verification-api-base-url>
Authorization: Bearer <token>
Content-Type: application/json

{
  "id_type": "C",
  "id_no": "ABCDE1234F"
}

Step 2: Continue CKYC

Follow with download and OTP validation per your compliance workflow.

Error handling

HTTP statusWhen
400Validation error.
401Invalid token.

Security notes

  • CKYC responses are sensitive; log only correlation ids.

Benefits

  • Standardizes CKYC pulls for lending and securities onboarding.

Next steps