---
title: "Get States API Reference"
description: "List the states (with their state_id) available for AePS Fingpay agent onboarding."
canonical: "https://eps.eko.in/docs/aeps-fingpay-states"
---


> **Canonical URL:** https://eps.eko.in/docs/aeps-fingpay-states
> 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.

# Get States API Reference

`GET https://staging.eko.in/ekoapi/v3/user/collection/aeps-fingpay/get-states`

List the states (with their state_id) available for AePS Fingpay agent onboarding.

Returns the list of states. Use the `value` of the chosen state as the `state_id` inside the `address_as_per_proof` and `office_address` objects in the Activate AePS Fingpay request.

> View product & pricing details: [AePS Cashout](https://eps.eko.in/products/aeps-api.md)

## Query parameters

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| initiator_id | string | yes | Registered mobile number of the API user (see Platform Credentials). e.g. 9962981729 |

## 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.param_attributes | object | Container for the returned list. |
| data.param_attributes.list_elements ⭐ | array | Array of available states. |
| data.param_attributes.list_elements.stateCode | string | Two-letter state code. |
| data.param_attributes.list_elements.label | string | State name (display to the agent). |
| data.param_attributes.list_elements.value ⭐ | number | Integer state ID — use as `state_id` in the address objects. |

## Response types

Branch on `response_type_id` to decide the next call:

| response_type_id | Meaning | Next step |
| --- | --- | --- |
| 2127 | State list returned successfully | [aeps-activate-fingpay](https://eps.eko.in/docs/aeps-activate-fingpay.md) |

## Example response

`response_type_id` `2127` — State list returned successfully. Next step: [aeps-activate-fingpay](https://eps.eko.in/docs/aeps-activate-fingpay.md).

```json
{
  "response_status_id": 0,
  "param_attributes": {
    "list_elements": [
      {
        "stateCode": "HR",
        "label": "Haryana",
        "value": 8
      },
      {
        "stateCode": "KA",
        "label": "Karnataka",
        "value": 12
      },
      {
        "stateCode": "MH",
        "label": "Maharashtra",
        "value": 15
      },
      {
        "stateCode": "SK",
        "label": "Sikkim",
        "value": 23
      },
      {
        "stateCode": "UP",
        "label": "Uttar Pradesh",
        "value": 27
      }
    ]
  },
  "response_type_id": 2127,
  "message": "Success",
  "status": 0
}
```