Onboard User

put https://staging.eko.in:25004/ekoapi/v3/user/account

Onboard your user (agent/merchant/retailer) on the platform. This is required for your users to use services on this platform.

It returns a unique user_code for the onboarded agent.

🚧
Note
While onboarding a user (or, agent) in production, please make sure you are providing correct details.
We verify the PAN number provided in this API and match the name returned with the name passed in this API. So, please pass a valid PAN number of the same agent that you are onboarding.

📘
Agent onboarding is mandatory for AePS.

Body Params

initiator_id

string

required

Your registered mobile number (See Platform Credentials for UAT)

pan_number

string

required

Pan Card Number of the agent

mobile

string

required

Verified mobile number of the agent

first_name

string

required

First name of the agent

middle_name

string

Middle Name of the agent

last_name

string

Last name of the agent

string

required

Email ID of the agent

residence_address

json

required

Residence Address of the agent

dob

date

required

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

shop_name

string

required

Shop name of the agent (Required for AePS onboarding)

Headers

developer_key

string

required

Your static API key (See Guide)

secret-key

string

required

Your dynamically generated security key, unique for every request (See Guide)

secret-key-timestamp

string

required

The current timestamp used to generate secret-key

Responses

Language

Credentials

Request


xxxxxxxxxx
1
curl -X POST \
2
  https://staging.eko.in/ekoapi/v3/user/account \
3
  -H 'Cache-Control: no-cache' \
4
  -H 'Content-Type: application/x-www-form-urlencoded' \
5
  -H 'developer_key: becbbce45f79c6f5109f848acd540567' \
6
  -H 'secret-key: MC6dKW278tBef+AuqL/5rW2K3WgOegF0ZHLW/FriZQw=' \
7
  -H 'secret-key-timestamp: 1516705204593' \
8
  -d 'initiator_id=9962981729&pan_number=BFUPM3499K&mobile=9123354235&first_name=Tina&last_name=Chawla&email=a@gmail.com&residence_address={"line": "Eko India","city":"Gurgaon","state":"Haryana","pincode":"122002","district":"Banswara","area":"Mongol"}&dob=1992-05-10&shop_name=Akanksha Stores'
9

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Onboard User

🚧
Note

📘
Agent onboarding is mandatory for AePS.

🚧Note

📘Agent onboarding is mandatory for AePS.

200200

400400

🚧
Note

📘
Agent onboarding is mandatory for AePS.