List users - Kira API

GET

users

List users

curl --request GET \
  --url https://api.balampay.com/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Api-Version: <x-api-version>' \
  --header 'x-api-key: <api-key>'

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "status": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "verification_status": "unverified",
    "verification_mode": "<string>",
    "verification_link": "<string>",
    "verification_link_error": "<string>",
    "metadata": {},
    "first_name": "<string>",
    "last_name": "<string>",
    "middle_name": "<string>",
    "phone": "<string>",
    "birth_date": "<string>",
    "nationality": "<string>",
    "residential_address": {
      "street_line_1": "<string>",
      "street_line_2": "<string>",
      "city": "<string>",
      "subdivision": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "formation_country": "<string>",
    "business_legal_name": "<string>",
    "company_name": "<string>",
    "business_type": "<string>",
    "business_trade_name": "<string>",
    "business_description": "<string>",
    "business_industry": [
      "<string>"
    ],
    "signed_agreement_id": "<string>",
    "registered_address": {
      "street_line_1": "<string>",
      "street_line_2": "<string>",
      "city": "<string>",
      "subdivision": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "physical_address": {
      "street_line_1": "<string>",
      "street_line_2": "<string>",
      "city": "<string>",
      "subdivision": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "has_material_intermediary_ownership": true,
    "account_purpose": "<string>",
    "source_of_funds": "<string>"
  }
]

Authorizations

Authorization

string

header

required

Access token from POST /auth (the data.access_token value).

x-api-key

string

header

required

API key issued by Kira. Required on every request, including /auth.

Headers

X-Api-Version

string

required

Example:

"2026-04-14"

Response

Success.

string<uuid>

required

type

enum<string>

required

Available options:

individual,

business

string<email>

required

status

string

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

verification_status

enum<string>

default:unverified

Available options:

unverified,

started,

in_review,

verified,

rejected,

needs_action

verification_mode

string

verification_link

string

verification_link_error

string

metadata

object

Show child attributes

first_name

string

last_name

string

middle_name

string

phone

string

birth_date

string

nationality

string

gender

enum<string>

Available options:

male,

female,

other

residential_address

object

Show child attributes

formation_country

string

business_legal_name

string

company_name

string

business_type

string

business_trade_name

string

business_description

string

business_industry

string[]

signed_agreement_id

string

registered_address

object

Show child attributes

physical_address

object

Show child attributes

has_material_intermediary_ownership

boolean

account_purpose

string

source_of_funds

string

Create a user**`account_purpose`** must be one of the 14 accepted values: `receive_payments | manage_professional_income | make_payments | manage_personal_funds | investment_trading | charitable_donations | investment_purposes | operating_a_company | payments_to_friends_or_family_abroad | personal_or_living_expenses | purchase_goods_and_services | protect_wealth | receive_salary | receive_payment_for_freelancing`. Any other value → `400 invalid_enum_value` listing these. **Sandbox can auto-REJECT on missing KYC data:** identity verification runs automatically on create (`verification_triggered: true`) and auto-REJECTs within seconds when required KYC data is missing (most commonly `source_of_funds`) (`user.verification.failed` webhook → terminal `REJECTED`; `verification_status` may still read `unverified` — gate on `status`). Include source\_of\_funds in the create payload. The rejection reason is delivered ONLY in the user.verification.failed webhook (data.reasons\[\]) — GET /v1/users/{id} never exposes it.

⌘I

List users

curl --request GET \
  --url https://api.balampay.com/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Api-Version: <x-api-version>' \
  --header 'x-api-key: <api-key>'

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "status": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "verification_status": "unverified",
    "verification_mode": "<string>",
    "verification_link": "<string>",
    "verification_link_error": "<string>",
    "metadata": {},
    "first_name": "<string>",
    "last_name": "<string>",
    "middle_name": "<string>",
    "phone": "<string>",
    "birth_date": "<string>",
    "nationality": "<string>",
    "residential_address": {
      "street_line_1": "<string>",
      "street_line_2": "<string>",
      "city": "<string>",
      "subdivision": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "formation_country": "<string>",
    "business_legal_name": "<string>",
    "company_name": "<string>",
    "business_type": "<string>",
    "business_trade_name": "<string>",
    "business_description": "<string>",
    "business_industry": [
      "<string>"
    ],
    "signed_agreement_id": "<string>",
    "registered_address": {
      "street_line_1": "<string>",
      "street_line_2": "<string>",
      "city": "<string>",
      "subdivision": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "physical_address": {
      "street_line_1": "<string>",
      "street_line_2": "<string>",
      "city": "<string>",
      "subdivision": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "has_material_intermediary_ownership": true,
    "account_purpose": "<string>",
    "source_of_funds": "<string>"
  }
]