PUTVerify OTP (eKYC)
Verify the eKYC OTP sent to the agent's Aadhaar-linked mobile number to advance the one-time AePS Fingpay eKYC.
The second step of the one-time AePS Fingpay eKYC flow (Send OTP → Verify OTP → Biometric Capture). Submits the OTP the agent received, together with the otp_ref_id and reference_tid returned by the Send OTP API, to validate the agent's identity before biometric capture. Aadhaar must be RSA-encrypted and Base64-encoded.
Body parameters
| Field | Type | Required | Description |
|---|---|---|---|
initiator_id | string | required | Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729 |
user_code | string | required | Unique code of your user/agent/retailer the service is run for. Use `Onboard Agent` API to register your userse.g. 20810200 |
customer_id | string | required | Registered mobile number of the agent/merchant undergoing eKYC.e.g. 9123456789 |
aadhaar | string | required | RSA-encrypted, Base64-encoded Aadhaar number of the agent undergoing eKYC.e.g. BASE64_ENCRYPTED_AADHAAR |
otp | string | required | OTP received on the agent's Aadhaar-registered mobile number.e.g. 123456 |
otp_ref_id | string | required | Reference ID returned by the Send OTP (eKYC) API.e.g. 2465238 |
reference_tid | string | required | Transaction reference ID returned by the Send OTP (eKYC) API.e.g. EKYKF4719702240123152147525I |
latlong | string | required | Agent's GPS coordinates as `latitude,longitude`. Required for security and fraud prevention.e.g. 28.6139,77.2090 |
initiator_idstringRequiredRegistered mobile number of the API user (see Platform Credentials).
example: 9962981729
user_codestringRequiredUnique code of your user/agent/retailer the service is run for. Use `Onboard Agent` API to register your users
example: 20810200
customer_idstringRequiredRegistered mobile number of the agent/merchant undergoing eKYC.
example: 9123456789
aadhaarstringRequiredRSA-encrypted, Base64-encoded Aadhaar number of the agent undergoing eKYC.
example: BASE64_ENCRYPTED_AADHAAR
otpstringRequiredOTP received on the agent's Aadhaar-registered mobile number.
example: 123456
otp_ref_idstringRequiredReference ID returned by the Send OTP (eKYC) API.
example: 2465238
reference_tidstringRequiredTransaction reference ID returned by the Send OTP (eKYC) API.
example: EKYKF4719702240123152147525I
latlongstringRequiredAgent's GPS coordinates as `latitude,longitude`. Required for security and fraud prevention.
example: 28.6139,77.2090
Headers
| Field | Type | Required | Description |
|---|---|---|---|
developer_key | string | required | Static API key issued to your account after KYC. |
secret-key | string | required | Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))). |
secret-key-timestamp | string | required | Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time. |
content-type | string | required | application/jsone.g. application/json |
developer_keystringRequiredStatic API key issued to your account after KYC.
secret-keystringRequiredDynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
secret-key-timestampstringRequiredCurrent time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
content-typestringRequiredapplication/json
example: application/json
Responses
statusnumberPrimary success indicator (0 = success).
messagestringHuman-readable response / error message.
response_status_idnumberGranular status id; see the shared error-codes table.
response_type_idnumberA unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobjectAPI-specific response payload.
user_codestringUser code of the agent whose eKYC was verified.
reference_tidstringTransaction reference ID for this eKYC verification.
otp_ref_idstringReference ID of the OTP session. Carry forward to the Biometric eKYC step.