PUTActivate AePS Fingpay for Agent

Onboard an agent for AePS Fingpay service by submitting their biometric device details and KYC documents.

PUT/admin/network/agent/{user_code}/aeps-fingpay/activate

This onboarding API registers an agent (identified by their user_code) for the AePS Fingpay service. It accepts the agent's biometric device model, serial number, address proofs, and KYC documents (PAN card, Aadhaar front and back) as a multipart form submission. After submission, the activation enters a 'pending' state and is approved within 2–3 business days. Only activated agents can perform AePS transactions. File uploads must be JPEG/JPG/PDF format, each under 1 MB; PNG is not accepted.

Path parameters

Field	Type	Required	Description
`user_code`	string	required	Unique code of the agent for whom AePS Fingpay service is being activated.e.g. 20810200

user_codestringRequired

Unique code of the agent for whom AePS Fingpay service is being activated.

example: 20810200

Body parameters

Field	Type	Required	Description
`initiator_id`	string	required	Registered mobile number of the API user (see Platform Credentials).e.g. 9962981729
`modelname`	string	required	Model name/designation of the UIDAI-certified biometric device (e.g., Morpho 1300E3, Mantra MFS100).e.g. Morpho 1300E3
`devicenumber`	string	required	Serial number of the biometric device as printed on the device or its packaging.e.g. SN1234567890
`office_address`	object	required	Agent's current office/operating address as a JSON object with keys: line, city, state, pincode.e.g. [object Object]
`address_as_per_proof`	object	required	Agent's address exactly as it appears on the submitted address proof document. JSON object with keys: line, city, state, pincode.e.g. [object Object]
`pan_card`	file	required	PAN card document upload (multipart/form-data). Accepted formats: JPEG, JPG, PDF. Max size: 1 MB. PNG not accepted.e.g. <binary file>
`aadhar_front`	file	required	Front side of the Aadhaar card (multipart/form-data). Accepted formats: JPEG, JPG, PDF. Max size: 1 MB.e.g. <binary file>
`aadhar_back`	file	required	Back side of the Aadhaar card (multipart/form-data). Accepted formats: JPEG, JPG, PDF. Max size: 1 MB.e.g. <binary file>

initiator_idstringRequired

Registered mobile number of the API user (see Platform Credentials).

example: 9962981729

modelnamestringRequired

Model name/designation of the UIDAI-certified biometric device (e.g., Morpho 1300E3, Mantra MFS100).

example: Morpho 1300E3

devicenumberstringRequired

Serial number of the biometric device as printed on the device or its packaging.

example: SN1234567890

office_addressobjectRequired

Agent's current office/operating address as a JSON object with keys: line, city, state, pincode.

example: [object Object]

address_as_per_proofobjectRequired

Agent's address exactly as it appears on the submitted address proof document. JSON object with keys: line, city, state, pincode.

example: [object Object]

pan_cardfileRequired

PAN card document upload (multipart/form-data). Accepted formats: JPEG, JPG, PDF. Max size: 1 MB. PNG not accepted.

example: <binary file>

aadhar_frontfileRequired

Front side of the Aadhaar card (multipart/form-data). Accepted formats: JPEG, JPG, PDF. Max size: 1 MB.

example: <binary file>

aadhar_backfileRequired

Back side of the Aadhaar card (multipart/form-data). Accepted formats: JPEG, JPG, PDF. Max size: 1 MB.

example: <binary file>

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	multipart/form-data — let your HTTP client set this header itself (it generates the required boundary); do not hardcode the value.e.g. multipart/form-data

developer_keystringRequired

Static API key issued to your account after KYC.

secret-keystringRequired

Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

secret-key-timestampstringRequired

Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

content-typestringRequired

multipart/form-data — let your HTTP client set this header itself (it generates the required boundary); do not hardcode the value.

example: multipart/form-data

Responses

statusnumber
Primary success indicator (0 = success).
messagestring
Human-readable response / error message.
response_status_idnumber
Granular status id; see the shared error-codes table.
response_type_idnumber
A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobject
API-specific response payload.
- activation_statusstring
  Current state of the AePS Fingpay activation request. 'pending' means documents are submitted and under review.
- activation_idstring
  Unique identifier for this activation request, for tracking and support.
- messagestring
  Human-readable message about the activation status.

Next steps

NextPOSTAePS Cash WithdrawalWithdraw cash from any Aadhaar-linked bank account using biometric fingerprint authentication — no card or PIN required.

Path parameters

Body parameters

Headers

Responses

Next steps

Related