BrandKwikID Documentation

CKYC Download

Download CKYC record data after search. Server-side POST with Bearer auth; requires CKYC number and auth factor fields.

API reference

Try itLoading playground…
Loading…
AuthorizationBearer <token>

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

In: header

ckyc_no?string

CKYC referance number for download from CKYC search API

auth_factor?string

Authentication factor (mobile number)

auth_factor_type?string

Authentication factor type (03 for mobile)

Default"03"

Response Body

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

Overview

Call POST /v3/api/ckyc/download from your backend after CKYC Search returns a ckyc_no. Send Authorization: Bearer <token> with JSON ckyc_no, auth_factor (mobile number), and auth_factor_type (default 03 for mobile in OpenAPI).

Key features

  • Stepwise CKYC: Search, then download with mobile-bound auth factor.
  • OTP follow-up: Pair with CKYC Validate OTP when your flow receives an OTP challenge.

Implementation

Step 1: Call from your backend

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

{
  "ckyc_no": "<from search>",
  "auth_factor": "9876543210",
  "auth_factor_type": "03"
}

Error handling

HTTP statusWhen
400Validation error.
401Invalid token.

Benefits

  • Retrieves standardized CKYC payload for downstream KYC storage.

Next steps