---
title: "Onboard Customer API Reference"
description: "Register a new customer on the platform; triggers an OTP to verify them."
canonical: "https://eps.eko.in/docs/onboard-customer"
---


> **Canonical URL:** https://eps.eko.in/docs/onboard-customer
> 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 Customer API Reference

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

Register a new customer on the platform; triggers an OTP to verify them.

Creates a rail-agnostic customer record. An OTP is dispatched and an `otp_ref_id` returned — call Verify Customer OTP next to complete onboarding.

> View product & pricing details: [Customer Management](https://eps.eko.in/products/customer-management-api.md)

## Path parameters

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

## Body parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| initiator_id | string | yes | Registered mobile number of the API user (see Platform Credentials). e.g. 9962981729 |
| user_code | string | yes | User code of the retailer/agent the service is run for. e.g. 20810200 |
| client_ref_id | string | no | Unique reference id per API call, generated by your system. e.g. REQ-20260101-001 |
| name | string | yes | Name of the customer as per ID. e.g. Karan Garg |
| dob | string | yes | Date of birth of the customer in YYYY-MM-DD format. e.g. 1990-05-15 |
| residence_address | array | yes | Customer's address as an array of strings. e.g. 123 MG Road,Bangalore,Karnataka,560001 |

## 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 | Granular status id; see the shared error-codes table. |
| 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.intent_id | number | Intent flag for the next step (19 = onboarding). |
| data.otp_ref_id ⭐ | string | OTP session reference — pass to Verify Customer OTP. |

## Example request

```json
{
  "initiator_id": "9962981729",
  "user_code": "20810200",
  "client_ref_id": "REQ-20260101-001",
  "name": "Karan Garg",
  "dob": "1990-05-15",
  "residence_address": [
    "123 MG Road",
    "Bangalore",
    "Karnataka",
    "560001"
  ]
}
```

## Example response

```json
{
  "response_status_id": 1,
  "data": {
    "intent_id": 19,
    "kyc_request_id": "",
    "otp_ref_id": "IXrygqm0vTNbN35Lp5AfcbP69ifPhQ1Ee3u74AHY5fA9aMp2d94YigSXr5Qr+aS8OTg/e0YrVEoPAbap746K5g=="
  },
  "response_type_id": 2129,
  "message": "Validate the OTP",
  "status": 2129
}
```