PUTActivate AePS Fingpay for Agent

Enable AePS Fingpay service for your agent by submitting their biometric device details and KYC documents.

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

This API enables an agent (identified by their user_code) to use 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.

Note

This API must be called after onboarding your agent using the Onboard User API.

Warning

The approval may take 1-2 business days.

Tip

This endpoint is one step in a complete workflow:

AePS (Fingpay) — Cash Withdrawal — Aadhaar-enabled cash withdrawal: one-time agent activation and eKYC, daily KYC, then the biometric withdrawal.

Request

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
`client_ref_id`	string	optional	Unique reference ID per API call, generated by your system (max 20 characters).e.g. 2026010100123456789
`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
`shop_type`	number	required	The shop-type ID of the Agent. Use `Get Shop Types` API for a list of shop-types and corresponding IDse.g. 4215
`office_address`	object	required	Agent's current office/operating address as a JSON object with keys: line, city, state, state_id, pincode. To get state_id, see the `Get States` APIe.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, sate_id, pincode. To get state_id, see the `Get States` APIe.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`Aadhaar Number	string	required	12-digit Aadhaar number of the sender.e.g. 123456789012
`aadhar_front`Aadhaar Front Image	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`Aadhaar Back Image	file	required	Back side of the Aadhaar card (multipart/form-data). Accepted formats: JPEG, JPG, PDF. Max size: 1 MB.e.g. <binary file>
`latlong`Geolocation	string	required	GPS coordinates of the agent for whom AePS Fingpay service is being activated. Format: <latitude,longitude>e.g. 28.6139,77.2090

initiator_idstringRequired

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

example: 9962981729

client_ref_idstringoptional

Unique reference ID per API call, generated by your system (max 20 characters).

example: 2026010100123456789

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

shop_typenumberRequired

The shop-type ID of the Agent. Use `Get Shop Types` API for a list of shop-types and corresponding IDs

example: 4215

office_addressobjectRequired

Agent's current office/operating address as a JSON object with keys: line, city, state, state_id, pincode. To get state_id, see the `Get States` API

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, sate_id, pincode. To get state_id, see the `Get States` API

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>

aadharstringRequired· Aadhaar Number

12-digit Aadhaar number of the sender.

example: 123456789012

aadhar_frontfileRequired· Aadhaar Front Image

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

example: <binary file>

aadhar_backfileRequired· Aadhaar Back Image

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

example: <binary file>

latlongstringRequired· Geolocation

GPS coordinates of the agent for whom AePS Fingpay service is being activated. Format: <latitude,longitude>

example: 28.6139,77.2090

These headers authenticate and sign every request. See How Auth Works for details.

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

Response types

response_type_id	Meaning	Next step
`1259`	AePS Registration Successful	Onboard Sender
`1297`	User does not exist	Onboard User

Responses

1259AePS Registration SuccessfulNext:Onboard Sender

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.
- service_status_descstring
  Current state of the AePS Fingpay activation request. 'pending' means documents are submitted and under review.
- service_statusnumber
  State-id of the AePS Fingpay activation request.

Next steps

NextGETGet Shop TypesList the Merchant Category Codes (MCC) available for AePS Fingpay agent onboarding.

Request

Path parameters

Body parameters

Response types

Responses

Next steps

Related