GETGet Sender Profile

Fetch the DMT-Levin profile of a sender by mobile number, including monthly, used and remaining limits.

GET/customer/profile/{customer_id}/dmt-levin

Warning

The UAT environment is not available for this API — requests to https://staging.eko.in/ekoapi/v3 return an error response. Test it in Production.

The first step in the DMT Levin flow. Call this to check whether the sender exists on the platform. For an existing sender (response_type_id 309) the response returns their monthly limit, used amount and remaining limit. For a new sender (response_type_id 2136) it returns an otp_ref_id — proceed to Validate Aadhaar & Generate OTP to create the sender before using other services.

Request

Path parameters

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

customer_idstringRequired

Sender's 10-digit mobile number.

example: 9999999999

Query 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	Agent user code (sent as a query parameter).e.g. 20180020

initiator_idstringRequired

Registered mobile number of the API user (see Platform Credentials).

example: 9962981729

client_ref_idstringoptional

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.

example: 2026010100123456789

user_codestringRequired

Agent user code (sent as a query parameter).

example: 20180020

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_keystringRequired

Static API key issued to your account after KYC.

secret-keystringRequired

Dynamic per-request signature: base64(HMAC-SHA256(timestamp, base64(access_key))).

secret-key-timestampstringRequired

Current time in milliseconds since UNIX epoch, used to compute secret-key. Must match server time.

content-typestringRequired

application/json

example: application/json

Response types

response_type_id	Meaning	Next step
`309`	Sender found	Get Recipients
`2136`	Sender not found, Aadhaar validation pending	Validate Aadhaar & Generate OTP

Responses

309Sender foundNext:Get Recipients

statusnumber
Primary success indicator (0 = success).
messagestring
Human-readable response / error message.
response_status_idnumber
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_idnumber
A unique id for every possible response shape (success or error) — useful for client logic branching and analytics.
dataobject
API-specific response payload.
- is_registerednumber
  Registration flag from the profile lookup. Read customer_profile.kyc_state to determine KYC completion.
- next_allowed_limitnumber
  Remaining remittance limit currently available (INR).
- kyc_statenumber
  Top-level KYC flag for the lookup response.
- customer_profileobject
  Sender profile summary.
  - namestring
    Sender name (null until set).
  - mobilestring
    Sender's mobile number.
  - balancestring
    Sender wallet balance (INR).
  - total_monthly_limitstring
    Sender's monthly remittance limit (INR).
  - next_allowed_limitstring
    Remaining limit currently available (INR).
  - kyc_statenumber
    Sender KYC state (1 = KYC complete on the profile).
  - chartarray
    Per-period limit-usage breakdown.
    - data_type_idnumber
      Identifier for the limit period/bucket.
    - dataobject
      Limit usage for the period.
      - unavailablenumber
        Amount blocked/unavailable (INR).
      - usednumber
        Amount already used (INR).
      - remainingnumber
        Remaining limit for the period (INR).
    - labelstring
      Display label for the period.

Next steps

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