Onboard Sender

post

https://staging.eko.in:25004/ekoapi/v3/customer/account/{customerid}.

Use this API to onboard a new sender and enable them for services such as PPI.

❗️
Name Parameter
Do not pass any random name! Pass the name as per the ID only, otherwise the transaction will fail

📘
OTP will not be delivered to the customer' mobile on UAT systems.

This API will trigger an OTP to be delivered to the customer. Use the Verify Sender OTP API to verify and onboard the customer.

Path Params

customer_id

string

required

Sender's mobile number

Body Params

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)

user_code

string

required

User code value of the retailer from whom the request is coming

name

string

required

Name of the sender as per id

dob

date

required

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

residence_address

array of strings

required

Address of the sender in JSON format

residence_address*

service_code

int32

Defaults to 80

Send a fixed value of 80

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

Response

Onboard Sender

❗️
Name Parameter

📘
OTP will not be delivered to the customer' mobile on UAT systems.

❗️Name Parameter

📘OTP will not be delivered to the customer' mobile on UAT systems.

200200

❗️
Name Parameter

📘
OTP will not be delivered to the customer' mobile on UAT systems.