---
title: "Onboard User API Reference"
description: "Register a new agent/retailer (merchant) on the EPS platform and receive their user_code."
canonical: "https://eps.eko.in/docs/onboard-user"
---


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

`POST https://staging.eko.in/ekoapi/v3/user/network/eps-agent`

Register a new agent/retailer (merchant) on the EPS platform and receive their user_code.

Onboards a merchant or retailer as a user on the platform. On success a unique `user_code` is returned — save it; every downstream request for that agent passes this `user_code`.

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

## 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 |
| pan_number | string | yes | PAN card number of the agent. e.g. ABCDE1234F |
| mobile | string | yes | Verified mobile number of the agent. e.g. 9876543210 |
| first_name | string | yes | First name of the agent. e.g. Ramesh |
| last_name | string | yes | Last name of the agent. e.g. Kumar |
| email | string | yes | Email ID of the agent. e.g. ramesh@example.com |
| residence_address | array | yes | Residence address of the agent as an array of strings. e.g. 123 MG Road,Bangalore,Karnataka,560001 |
| dob | string | yes | Date of birth of the agent in YYYY-MM-DD format. e.g. 1990-05-15 |
| shop_name | string | yes | Shop name of the agent (required for AePS onboarding). e.g. Ramesh Mobile Store |

## 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.user_code ⭐ | string | Unique code for the onboarded agent — save it and pass on every downstream request. |
| data.initiator_id | string | Your registered initiator id (echoed back). |

## Example request

```json
{
  "initiator_id": "9962981729",
  "user_code": "20810200",
  "client_ref_id": "REQ-20260101-001",
  "pan_number": "ABCDE1234F",
  "mobile": "9876543210",
  "first_name": "Ramesh",
  "last_name": "Kumar",
  "email": "ramesh@example.com",
  "residence_address": [
    "123 MG Road",
    "Bangalore",
    "Karnataka",
    "560001"
  ],
  "dob": "1990-05-15",
  "shop_name": "Ramesh Mobile Store"
}
```

## Example response

```json
{
  "response_status_id": -1,
  "data": {
    "user_code": "20110002",
    "initiator_id": "9962981729"
  },
  "response_type_id": 1290,
  "message": "User onboarding successfull",
  "status": 0
}
```