PUTSender eKYC (Biometric)
Initiate biometric Aadhaar eKYC to verify and upgrade a DMT sender's account.
Performs biometric eKYC using fingerprint data linked to the sender's Aadhaar number. Requires a compatible biometric capture device. The biometric PID data (XML payload) is captured at the agent's terminal and submitted along with the Aadhaar number. On success the system dispatches an OTP for confirmation; call Validate eKYC OTP next. A successful eKYC upgrades the sender's monthly limit from ₹5,000 to ₹25,000.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
customer_id | string | required | Sender's 10-digit mobile number.e.g. 9123456789 |
customer_idstringRequiredSender's 10-digit mobile number.
example: 9123456789
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 |
aadhar | string | required | 12-digit Aadhaar number of the sender.e.g. 234567890123 |
piddata | string | required | XML-encoded biometric PID data captured from a certified biometric device (fingerprint scanner).e.g. <PidData><Resp errCode="0" errInfo="Capture Success" .../></PidData> |
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
aadharstringRequired12-digit Aadhaar number of the sender.
example: 234567890123
piddatastringRequiredXML-encoded biometric PID data captured from a certified biometric device (fingerprint scanner).
example: <PidData><Resp errCode="0" errInfo="Capture Success" .../></PidData>
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_request_idstringUnique identifier for this KYC request. Required for the Validate eKYC OTP step.
otp_ref_idstringReference ID for the OTP sent to the sender's Aadhaar-linked mobile.
mobilestringMasked mobile number to which the OTP was dispatched.