POSTOnboard Sender
Register a new customer as a DMT-Levin sender using basic KYC details.
https://staging.eko.in/ekoapi/v3 return an error response. Test it in Production.Onboards a new sender and enables them for the DMT-Levin service. Provide the sender's name, date of birth, and residence address. Pass the name exactly as per the sender's ID — a random or mismatched name makes the transaction fail. On success the response (response_type_id 2136) returns an otp_ref_id — proceed to Validate Aadhaar & Generate OTP. OTP is not delivered to the customer's mobile on UAT systems.
Request
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
customer_id | string | required | Sender's 10-digit mobile number.e.g. 9999999999 |
customer_idstringRequiredSender's 10-digit mobile number.
example: 9999999999
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 (10–20 characters; 10 recommended). The SDKs generate one for every non-GET call when you don't.e.g. 2026010100123456789 |
user_code | string | required | User code value of the retailer from whom the request is coming.e.g. 99080253 |
name | string | required | Full name of the sender as per their ID. Do not pass a random name — the transaction will fail.e.g. Gaurav |
dob | string | required | Date of birth of the sender in YYYY-MM-DD format.e.g. 1997-07-01 |
residence_address | object | required | Sender's residence address as a nested JSON object with keys: line, city, state, pincode, district, area.e.g. {"line":"India","city":"Lucknow","state":"Uttar pradesh","pincode":"226024","district":"Lucknow","area":"gomtinagar"} |
initiator_idstringRequiredRegistered mobile number of the API user (see Platform Credentials).
example: 9962981729
client_ref_idstringoptionalUnique reference ID per API call, generated by your system (10–20 characters; 10 recommended). The SDKs generate one for every non-GET call when you don't.
example: 2026010100123456789
user_codestringRequiredUser code value of the retailer from whom the request is coming.
example: 99080253
namestringRequiredFull name of the sender as per their ID. Do not pass a random name — the transaction will fail.
example: Gaurav
dobstringRequiredDate of birth of the sender in YYYY-MM-DD format.
example: 1997-07-01
residence_addressobjectRequiredSender's residence address as a nested JSON object with keys: line, city, state, pincode, district, area.
example: [object Object]
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_keystringRequiredStatic API key issued to your account after KYC.
secret-keystringRequiredDynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).
secret-key-timestampstringRequiredCurrent time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.
content-typestringRequiredapplication/json
example: application/json
Response types
| response_type_id | Meaning | Next step |
|---|---|---|
2136 | Onboarded, Aadhaar validation pending | Validate Aadhaar & Generate OTP |
Responses
2136Onboarded, Aadhaar validation pendingNext:Validate Aadhaar & Generate OTP
statusnumberPrimary success indicator (0 = success).
messagestringHuman-readable response / error message.
response_status_idnumberUI display hint only (-1/0 success, 1 failure, 2 initiated, 3 refund initiated, 4 refunded). Never branch on it — use `status` (and `tx_status` for financial APIs), or `response_type_id` where documented.
response_type_idnumberA unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobjectAPI-specific response payload.
otp_ref_idstringOTP reference — pass to Validate Aadhaar & Generate OTP.