POSTAePS Fingpay — Biometric eKYC
Complete one-time AePS Fingpay eKYC by submitting the agent's Aadhaar and live biometric fingerprint capture.
The final step in the one-time AePS Fingpay eKYC flow, called after OTP verification. Submits the agent's Aadhaar and biometric PID data to UIDAI for identity verification. On success, the agent's eKYC is marked complete and they can start performing AePS transactions (subject to completing daily 2FA each day). This step uses the same RSA-encrypted Aadhaar and PID XML format as the transaction APIs.
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 | User code of the retailer/agent the service is run for.e.g. 20810200 |
client_ref_id | string | optional | Unique reference id per API call, generated by your system.e.g. REQ-20260101-001 |
aadhaar | string | required | RSA-encrypted, Base64-encoded Aadhaar number of the agent.e.g. BASE64_ENCRYPTED_AADHAAR |
piddata | string | required | PID XML string from the UIDAI-certified biometric device (fType=2, Data type='X', mc in DeviceInfo).e.g. <?xml version='1.0'?><PidData><Data type='X'>...</Data><DeviceInfo mc='...' /></PidData> |
otp_ref_id | string | required | Reference ID returned by the Send OTP (eKYC) API, linking this biometric capture to the verified OTP session.e.g. OTPREF20240101001 |
initiator_idstringRequiredRegistered mobile number of the API user (see Platform Credentials).
example: 9962981729
user_codestringRequiredUser code of the retailer/agent the service is run for.
example: 20810200
client_ref_idstringoptionalUnique reference id per API call, generated by your system.
example: REQ-20260101-001
aadhaarstringRequiredRSA-encrypted, Base64-encoded Aadhaar number of the agent.
example: BASE64_ENCRYPTED_AADHAAR
piddatastringRequiredPID XML string from the UIDAI-certified biometric device (fType=2, Data type='X', mc in DeviceInfo).
example: <?xml version='1.0'?><PidData><Data type='X'>...</Data><DeviceInfo mc='...' /></PidData>
otp_ref_idstringRequiredReference ID returned by the Send OTP (eKYC) API, linking this biometric capture to the verified OTP session.
example: OTPREF20240101001
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.
kyc_statusstringResult of the eKYC verification. 'completed' means the agent is now KYC-verified for AePS.
aadhaar_ref_numstringUIDAI authentication reference number for the biometric capture.