---
title: "Biometric eKYC API Reference"
description: "Complete one-time AePS Fingpay eKYC by submitting the agent's Aadhaar and live biometric fingerprint capture."
canonical: "https://eps.eko.in/docs/aeps-fingpay-biometric-ekyc"
---


> **Canonical URL:** https://eps.eko.in/docs/aeps-fingpay-biometric-ekyc
> This is a machine-readable Markdown version of the page for AI agents and LLMs. The primary (HTML) version lives at the canonical URL above.

# Biometric eKYC API Reference

`PUT https://staging.eko.in/ekoapi/v3/user/collection/aeps-fingpay/kyc/biometric`

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 RSA-encrypted Aadhaar and live biometric PID to UIDAI; on success the agent is eligible for AePS transactions.

If you generate the PID block with your own code rather than the RD service default, set `wadh=E0jzJ/P8UopUHAieZn8CKqS4WPMi5ZSYXgfnlfkWjrc=` alongside `fCount`, `fType` and the other attributes.

To capture the `piddata` PID block with an RDService-compliant fingerprint scanner, see the [Aadhaar Biometric Authentication guide](/docs/aadhaar-biometric-rdservice).

> View product & pricing details: [AePS Cashout](https://eps.eko.in/products/aeps-api.md)

## Body parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| initiator_id | string | yes | Registered mobile number of the API user (see Platform Credentials). e.g. 9962981729 |
| client_ref_id | string | no | Unique reference ID per API call, generated by your system (max 20 characters). e.g. 2026010100123456789 |
| user_code | string | yes | Unique code of your user/agent/retailer the service is run for. Use `Onboard Agent` API to register your users e.g. 20810200 |
| aadhar | string | yes | RSA-encrypted, Base64-encoded Aadhaar number of the agent. e.g. BASE64_ENCRYPTED_AADHAAR |
| customer_id | string | yes | Registered mobile number of the agent/merchant undergoing eKYC. e.g. 9123456789 |
| latlong | string | yes | Agent's GPS coordinates as `latitude,longitude`. Required for security and fraud prevention. e.g. 28.6139,77.2090 |
| piddata | string | yes | 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> |
| bank_code | string | yes | Eko bank code of the agent's bank. Resolve it using the [Get List of Banks](./get-banks) API. e.g. HDFC |
| otp_ref_id | string | yes | Reference ID returned by the preceding OTP step, linking this biometric capture to the verified OTP session. e.g. 2465238 |
| reference_tid | string | yes | Transaction reference ID returned by the preceding OTP step. e.g. EKYKF4719702240123152147525I |

## Headers

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| developer_key | string | yes | Static API key issued to your account after KYC. |
| secret-key | string | yes | Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))). |
| secret-key-timestamp | string | yes | Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time. |
| content-type | string | yes | application/json e.g. application/json |

## Response

⭐ marks fields highlighted as verifiable.

| Field | Type | Description |
| --- | --- | --- |
| status | number | Primary success indicator (0 = success). |
| message | string | Human-readable response / error message. |
| response_status_id | number | Granular status id; see the shared error-codes table. |
| response_type_id | number | A unique id for every possible response shape (success or error) — useful for client logic branching and analytics. |
| data | object | API-specific response payload. |
| data.user_code ⭐ | string | User code of the agent whose eKYC is now complete. |

## Response types

Branch on `response_type_id` to decide the next call:

| response_type_id | Meaning | Next step |
| --- | --- | --- |
| 1605 | eKYC successful — agent may now complete Daily KYC | [aeps-fingpay-daily-auth](https://eps.eko.in/docs/aeps-fingpay-daily-auth.md) |

## Example request

```json
{
  "initiator_id": "9962981729",
  "client_ref_id": "2026010100123456789",
  "user_code": "20810200",
  "aadhar": "BASE64_ENCRYPTED_AADHAAR",
  "customer_id": "9123456789",
  "latlong": "28.6139,77.2090",
  "piddata": "<?xml version='1.0'?><PidData><Data type='X'>...</Data><DeviceInfo mc='...' /></PidData>",
  "bank_code": "HDFC",
  "otp_ref_id": "2465238",
  "reference_tid": "EKYKF4719702240123152147525I"
}
```

## Example response

`response_type_id` `1605` — eKYC successful — agent may now complete Daily KYC. Next step: [aeps-fingpay-daily-auth](https://eps.eko.in/docs/aeps-fingpay-daily-auth.md).

```json
{
  "response_status_id": 0,
  "data": {
    "user_code": "20810200"
  },
  "response_type_id": 1605,
  "message": "Congratulations! eKYC successful",
  "status": 0
}
```

## Error scenarios

| Status | response_type_id | Scenario |
| --- | --- | --- |
| 200 | `461` | OTP steps skipped — Send OTP and Verify OTP must both succeed first |