---
title: "Onboard Sender API Reference"
description: "Register a new customer as a DMT-Levin sender using basic KYC details."
canonical: "https://eps.eko.in/docs/dmt-levin-onboard-sender"
---


> **Canonical URL:** https://eps.eko.in/docs/dmt-levin-onboard-sender
> This is a machine-readable Markdown version of the page for AI agents and LLMs. The primary (HTML) version lives at the canonical URL above.

# Onboard Sender API Reference

`POST https://staging.eko.in/ekoapi/v3/customer/account/{customer_id}/dmt-levin`

Register a new customer as a DMT-Levin sender using basic KYC details.

> [!WARNING]
> The UAT / Sandbox environment is not available for this API — requests to `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.

> View product & pricing details: [Domestic Money Transfer (DMT)](https://eps.eko.in/products/dmt-api.md)

## Path parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| customer_id | string | yes | Sender's 10-digit mobile number. e.g. 9999999999 |

## Body parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| initiator_id | string | yes | Registered mobile number of the API user (see Platform Credentials). e.g. 9962981729 |
| client_ref_id | string | no | 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 | yes | User code value of the retailer from whom the request is coming. e.g. 99080253 |
| name | string | yes | Full name of the sender as per their ID. Do not pass a random name — the transaction will fail. e.g. Gaurav |
| dob | string | yes | Date of birth of the sender in YYYY-MM-DD format. e.g. 1997-07-01 |
| residence_address | object | yes | Sender's residence address as a nested JSON object with keys: line, city, state, pincode, district, area. e.g. [object Object] |

## Headers

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| developer_key | string | yes | Static API key issued to your account after KYC. |
| secret-key | string | yes | Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))). |
| secret-key-timestamp | string | yes | Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time. |
| content-type | string | yes | application/json e.g. application/json |

## Response

⭐ marks fields highlighted as verifiable.

| Field | Type | Description |
| --- | --- | --- |
| status | number | Primary success indicator (0 = success). |
| message | string | Human-readable response / error message. |
| response_status_id | number | UI 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_id | number | A unique id for every possible response shape (success or error) — useful for client logic branching and analytics. |
| data | object | API-specific response payload. |
| data.otp_ref_id ⭐ | string | OTP reference — pass to Validate Aadhaar & Generate OTP. |

## Response types

Branch on `response_type_id` to decide the next call:

| response_type_id | Meaning | Next step |
| --- | --- | --- |
| 2136 | Onboarded, Aadhaar validation pending | [aadhaar-dmt-levin-validate](https://eps.eko.in/docs/aadhaar-dmt-levin-validate.md) |

## Example request

```json
{
  "initiator_id": "9962981729",
  "client_ref_id": "2026010100123456789",
  "user_code": "99080253",
  "name": "Gaurav",
  "dob": "1997-07-01",
  "residence_address": {
    "line": "India",
    "city": "Lucknow",
    "state": "Uttar pradesh",
    "pincode": "226024",
    "district": "Lucknow",
    "area": "gomtinagar"
  }
}
```

## Example response

`response_type_id` `2136` — Onboarded, Aadhaar validation pending. Next step: [aadhaar-dmt-levin-validate](https://eps.eko.in/docs/aadhaar-dmt-levin-validate.md).

```json
{
  "response_status_id": 1,
  "data": {
    "otp_ref_id": "MjQzMjYxMjQzMTMyMjQ2YTJlNWEzOTc5MzU1MTRiNDg1OTc0MzU1NjYxNDE3NzQ3NTgzNjZlNzg3NTUxNjk2ODQ2NzE0ZTQ5NzE0NzcyNTg2MjZkNTc3MTY2NGI3NjRiMzA2NzM4NTk0MzUwNTg3NjRlNTQ1MjY5"
  },
  "response_type_id": 2136,
  "message": "Aadhar Validation Pending",
  "status": 2136
}
```