BrandKwikID Documentation

CKYC Validate OTP

Validate OTP for a CKYC download session. 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

validate?string

Validation flag (Y/N)

Default"Y"
otp?string

OTP received for validation

ckyc_no?string

CKYC referance number for OTP validation from CKYC search API

Response Body

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

Overview

Call POST /v3/api/ckyc/validate-otp from your backend when the user receives an OTP during the CKYC download journey. Send Authorization: Bearer <token> with JSON otp, ckyc_no, and optional validate flag (Y default in OpenAPI).

Key features

  • Completes OTP-gated download flows started from CKYC Download.
  • Server-side OTP handling keeps SMS secrets off public clients.

Implementation

Step 1: Call from your backend

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

{
  "ckyc_no": "<ckyc number>",
  "otp": "<sms otp>",
  "validate": "Y"
}

Error handling

HTTP statusWhen
400Wrong OTP or validation error.
401Invalid token.

Benefits

  • Lets you finish CKYC retrieval without manual operations desk steps.

Next steps