POSTOnboard User

POST/user/network/eps-agent

Onboards a merchant or retailer as a user on the platform. On success a unique user_code is returned — save it; every downstream request for that agent passes this user_code.

Request

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
`pan_number`	string	required	PAN card number of the agent.e.g. ABCDE1234F
`mobile`	string	required	Verified mobile number of the agent.e.g. 9876543210
`first_name`	string	required	First name of the agent.e.g. Ramesh
`last_name`	string	required	Last name of the agent.e.g. Kumar
`email`	string	required	Email ID of the agent.e.g. ramesh@example.com
`residence_address`	array	required	Residence address of the agent as an array of strings.e.g. 123 MG Road,Bangalore,Karnataka,560001
`dob`	string	required	Date of birth of the agent in YYYY-MM-DD format.e.g. 1990-05-15
`shop_name`	string	required	Shop name of the agent (required for AePS onboarding).e.g. Ramesh Mobile Store

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

pan_numberstringRequired

PAN card number of the agent.

example: ABCDE1234F

mobilestringRequired

Verified mobile number of the agent.

example: 9876543210

first_namestringRequired

First name of the agent.

example: Ramesh

last_namestringRequired

Last name of the agent.

example: Kumar

emailstringRequired

Email ID of the agent.

example: ramesh@example.com

residence_addressarrayRequired

Residence address of the agent as an array of strings.

example: 123 MG Road,Bangalore,Karnataka,560001

dobstringRequired

Date of birth of the agent in YYYY-MM-DD format.

example: 1990-05-15

shop_namestringRequired

Shop name of the agent (required for AePS onboarding).

example: Ramesh Mobile Store

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	application/jsone.g. application/json

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

application/json

example: application/json

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.
- user_codestring
  Unique code for the onboarded agent — save it and pass on every downstream request.
- initiator_idstring
  Your registered initiator id (echoed back).

Next steps

NextPUTActivate Service for UserActivate a specific service (by service code) for one of your agents/retailers.

Request

Body parameters

Responses

Next steps

Related