Onboard User

put

https://staging.eko.in/ekoapi/v1/user/onboard

The Onboard User API helps you quickly add new merchants or retailers to the platform.

🚧
Note
When onboarding a merchant in production, it's crucial to provide accurate information. We verify the PAN number you provide in the Onboard User API by matching it with the name returned during PAN verification. Please ensure that the PAN number and the name you enter belong to the same merchant/user.

📘
To generate secret-key and secret-key-timestamp, refer to - Authentication

👍
A unique user code will be returned after onboarding the merchant.

📘
For AePS, merchant onboarding is mandatory.

Form Data

initiator_id

string

required

The unique cell number with which you are onboarded on Eko's platform. For UAT refer to [Platform Credentials] (https://developers.eko.in/docs/platform-credentials)

pan_number

string

required

Pan Card Number of the User

mobile

string

required

The number which you verified and want to onboard

first_name

string

required

First name of the user

middle_name

string

Middle Name of the user

last_name

string

Last name of the user

string

required

Email of the user/merchant

residence_address

json

required

Residence Address of the user

dob

date

required

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

shop_name

string

required

Shop name of the merchant ( Required for AePS onboarding)

Headers

developer_key

string

required

Your unique API key that will authenticate your request. For UAT, refer to [Platform Credentials] (https://developers.eko.in/docs/platform-credentials)

secret-key

string

required

Refer to [authentication section] (https://developers.eko.in/docs/authentication)

secret-key-timestamp

string

required

Refer to [authentication section] (https://developers.eko.in/docs/authentication)

Responses

Onboard User

🚧
Note

📘
To generate secret-key and secret-key-timestamp, refer to - Authentication

👍
A unique user code will be returned after onboarding the merchant.

📘
For AePS, merchant onboarding is mandatory.

🚧Note

📘To generate secret-key and secret-key-timestamp, refer to - Authentication

👍A unique user code will be returned after onboarding the merchant.

📘For AePS, merchant onboarding is mandatory.

200200

400400

🚧
Note

📘
To generate secret-key and secret-key-timestamp, refer to - Authentication

👍
A unique user code will be returned after onboarding the merchant.

📘
For AePS, merchant onboarding is mandatory.