Users

List users

Use limit<=100 — limit is validated, and a value above 100 (or below 1) returns a clean 400 validation error ({"code": "validation_error", "message": "Invalid query parameters", ...}); the same cap applies to GET /v1/virtual-accounts and ALL list endpoints. Pass include_eligibility=true to also include capabilities.requested_banks and eligible_products on every row, identical in shape to GET /v1/users/{user_id} — omitted by default to keep the response light for callers that don’t need them.

GET

users

List users

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

import requests

url = "https://api.balampay.com/v1/users"

headers = {
    "Authorization": "Bearer <token>",
    "x-api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'x-api-key': '<api-key>'}
};

fetch('https://api.balampay.com/v1/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.balampay.com/v1/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.balampay.com/v1/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "individual",
      "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>",
      "verification_link_error_severity": "deferred",
      "metadata": {},
      "first_name": "<string>",
      "last_name": "<string>",
      "middle_name": "<string>",
      "phone": "<string>",
      "birth_date": "<string>",
      "nationality": "<string>",
      "gender": "male",
      "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>"
      ],
      "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>",
      "eligible_products": [
        {
          "product_id": "<string>",
          "product_code": "<string>",
          "product_name": "<string>",
          "eligible": true,
          "missing_fields": [
            "<string>"
          ],
          "unsupported_reason": "enhanced_due_diligence_required"
        }
      ],
      "missing_fields": {},
      "capabilities": {
        "requested_banks": [
          "<string>"
        ]
      }
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "has_more": true
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

Stable since 2025-01-01 — unchanged in 2026-04-14.

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

Optional. The date-versioned API version to apply for this request (e.g. 2026-04-14). When sent it always wins, even over your pinned account default. When omitted, the API uses your account's pinned version if set, otherwise a baseline default.

Example:

"2026-04-14"

Query Parameters

limit

integer

default:10

Maximum number of users to return (1-100).

Required range: 1 <= x <= 100

offset

integer

default:0

Number of users to skip for pagination.

Required range: x >= 0

status

enum<string>

Filter by user status.

Available options:

CREATED,

VERIFYING,

VERIFIED,

REJECTED,

REVIEW,

ACTIVE,

INACTIVE,

SUSPENDED

type

enum<string>

Filter by user type.

Available options:

individual,

business

string

Substring match against the user's email.

verification_status

enum<string>

Filter by verification status. Accepts the same lowercase values the response's verification_status field carries.

Available options:

unverified,

started,

in_review,

verified,

rejected,

needs_action

created_after

string<date-time>

Return users created at or after this ISO 8601 date-time.

created_before

string<date-time>

Return users created at or before this ISO 8601 date-time.

metadata

object

Stripe-style metadata filter — ?metadata[key]=value deep-object form. Each key must be 1-40 characters and must not contain [ or ]. Multiple keys are AND-ed.

Show child attributes

include_eligibility

boolean

default:false

When true, each row also includes capabilities.requested_banks and eligible_products. Omitted (false) by default — computing eligibility for every row costs a lookup plus in-memory evaluation per subclient, so it's opt-in rather than always paid by every list caller.

Response

Success.

data

object[]

Show child attributes

pagination

object

Show child attributes

List users

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

import requests

url = "https://api.balampay.com/v1/users"

headers = {
    "Authorization": "Bearer <token>",
    "x-api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'x-api-key': '<api-key>'}
};

fetch('https://api.balampay.com/v1/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.balampay.com/v1/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.balampay.com/v1/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.balampay.com/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "individual",
      "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>",
      "verification_link_error_severity": "deferred",
      "metadata": {},
      "first_name": "<string>",
      "last_name": "<string>",
      "middle_name": "<string>",
      "phone": "<string>",
      "birth_date": "<string>",
      "nationality": "<string>",
      "gender": "male",
      "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>"
      ],
      "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>",
      "eligible_products": [
        {
          "product_id": "<string>",
          "product_code": "<string>",
          "product_name": "<string>",
          "eligible": true,
          "missing_fields": [
            "<string>"
          ],
          "unsupported_reason": "enhanced_due_diligence_required"
        }
      ],
      "missing_fields": {},
      "capabilities": {
        "requested_banks": [
          "<string>"
        ]
      }
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "has_more": true
  }
}

{
  "message": "<string>",
  "code": "<string>",
  "statusCode": 123,
  "error": "<string>",
  "timestamp": "<string>",
  "path": "<string>",
  "details": "<unknown>"
}

Authentication

Versioning

Users

Virtual Accounts

Quotations

Payouts

Recipients

Reference

List users

Authorizations

Headers

Query Parameters

Response