Accounts

GetAccountCountries returns the list of countries associated with an account

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/accounts/{accountId}/countries

Set via UpdateAccountCountries — for the full catalog of registered countries use ListCountries instead

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

accountIdstringRequired

account_id represents the account identifier

Responses

200

A successful response.

application/json

countriesstring[]Required

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/accounts/v1/accounts/{accountId}/countries

HTTPcURLJavaScriptPython

GET /accounts/v1/accounts/{accountId}/countries HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "countries": [
    "text"
  ]
}

GetUserByAccountId returns the user information for the provided account id

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/accounts/{accountId}/user

Resolves account_id to its owning user. Pairs with GetAccountInfo once the user_id is known

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

accountIdstringRequired

account_id represents the account identifier

Responses

200

A successful response.

application/json

accountsstring[]Required

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/accounts/v1/accounts/{accountId}/user

HTTPcURLJavaScriptPython

GET /accounts/v1/accounts/{accountId}/user HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "accounts": [
    "text"
  ],
  "user": {
    "admin": true,
    "createdAt": "2026-08-10T22:15:25.577Z",
    "deletedAt": "2026-08-10T22:15:25.577Z",
    "displayName": "text",
    "email": "text",
    "emailVerified": true,
    "id": "text",
    "isMfaEnabled": true,
    "language": "text",
    "lockReason": "text",
    "locked": true,
    "passwordChangedAt": "2026-08-10T22:15:25.577Z",
    "superAdmin": true,
    "updatedAt": "2026-08-10T22:15:25.577Z"
  }
}

ListCountries returns all countries registered in the platform

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/countries

The full reference for countries, not scoped to any account — see GetAccountCountries for a specific account's countries

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/accounts/v1/countries

HTTPcURLJavaScriptPython

GET /accounts/v1/countries HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "countries": [
    {
      "code": "text",
      "name": "text"
    }
  ]
}

ListAccountLevels returns the existing levels for accounts

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/levels

Supports optional filtering by account_type and level

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Query parameters

accountTypestringOptional

account_type is an optional query parameter to filter leves by account type

levelinteger · int32Optional

level is an optional query parameter to filter leves by level

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/accounts/v1/levels

HTTPcURLJavaScriptPython

GET /accounts/v1/levels HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "levels": [
    {
      "accountType": "text",
      "description": "text",
      "id": "text",
      "level": 1,
      "name": "text"
    }
  ]
}

ListAccountLimits returns the existing limits for accounts

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/limits

The configured defaults per level/action, not a specific account's effective limits — use GetAccountLimits for that

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/accounts/v1/limits

HTTPcURLJavaScriptPython

GET /accounts/v1/limits HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "limits": [
    {
      "accountType": "text",
      "active": true,
      "amountUsd": "text",
      "description": "text",
      "id": "text",
      "level": 1,
      "limitAction": "text",
      "name": "text",
      "periodDays": 1
    }
  ]
}

ListAccountLimitOverrides returns all the overrides information for the provided account id

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/limits/overrides

List of overrides, not scoped to a single account. Includes each override's reason and active status

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/accounts/v1/limits/overrides

HTTPcURLJavaScriptPython

GET /accounts/v1/limits/overrides HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "overrides": [
    {
      "accountId": "text",
      "active": true,
      "amountUsd": "text",
      "id": "text",
      "limitAction": "text",
      "periodDays": 1,
      "reason": "text"
    }
  ]
}

GetAllRailSchemas handle the request to get all rail schemas

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/rails/schemas

Each schema describes the payload shape a rail_code/rail_version expects Use this to build the payload for RegisterWithdrawalDestination. Country optionally filters to rails available in that country

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Query parameters

countrystringOptional

country represents the country associated to the rail schemas

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/accounts/v1/rails/schemas

HTTPcURLJavaScriptPython

GET /accounts/v1/rails/schemas HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "schemas": [
    {
      "country": "text",
      "railCode": "text",
      "railVersion": 1,
      "schema": {
        "fields": [
          {
            "name": "text",
            "optional": true,
            "options": [
              "text"
            ],
            "pattern": "text",
            "type": "text"
          }
        ],
        "title": "text"
      },
      "type": "text"
    }
  ]
}

GetUserAccounts returns all accounts associated to the provided user_id

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/users/{userId}/accounts

Full account objects (KYC, wallets) for every account the user holds for a single account use GetAccountInfo instead

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/accounts/v1/users/{userId}/accounts

HTTPcURLJavaScriptPython

GET /accounts/v1/users/{userId}/accounts HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "accounts": [
    {
      "accountName": "text",
      "accountType": "text",
      "countries": [
        "text"
      ],
      "createdAt": "2026-08-10T22:15:25.577Z",
      "deletedAt": "2026-08-10T22:15:25.577Z",
      "id": "text",
      "kycInfo": {
        "level": 1,
        "provider": "text",
        "requestedAt": "2026-08-10T22:15:25.577Z",
        "status": "text",
        "verifiedAt": "2026-08-10T22:15:25.577Z"
      },
      "privyId": "text",
      "updatedAt": "2026-08-10T22:15:25.577Z",
      "userId": "text",
      "wallets": [
        {
          "address": "text",
          "chainType": "text",
          "id": "text"
        }
      ]
    }
  ]
}

GetAccountInfo returns the account information for the provided account id

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/users/{userId}/accounts/{accountId}

Scoped under a user_id. Use GetUserByAccountId if only the account_id is known and the owning user needs to be resolved first

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

accountIdstringRequired

account_id represents the account identifier

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/accounts/v1/users/{userId}/accounts/{accountId}

HTTPcURLJavaScriptPython

GET /accounts/v1/users/{userId}/accounts/{accountId} HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "account": {
    "accountName": "text",
    "accountType": "text",
    "countries": [
      "text"
    ],
    "createdAt": "2026-08-10T22:15:25.577Z",
    "deletedAt": "2026-08-10T22:15:25.577Z",
    "id": "text",
    "kycInfo": {
      "level": 1,
      "provider": "text",
      "requestedAt": "2026-08-10T22:15:25.577Z",
      "status": "text",
      "verifiedAt": "2026-08-10T22:15:25.577Z"
    },
    "privyId": "text",
    "updatedAt": "2026-08-10T22:15:25.577Z",
    "userId": "text",
    "wallets": [
      {
        "address": "text",
        "chainType": "text",
        "id": "text"
      }
    ]
  }
}

GetAccountLimits returns the limits information for the provided account id

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/users/{userId}/accounts/{accountId}/limits

Merges the level's default limits with any active per-account overrides, and includes current usage

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

accountIdstringRequired

account_id represents the account identifier

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/accounts/v1/users/{userId}/accounts/{accountId}/limits

HTTPcURLJavaScriptPython

GET /accounts/v1/users/{userId}/accounts/{accountId}/limits HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "limits": [
    {
      "amountUsd": "text",
      "id": "text",
      "level": 1,
      "limitAction": "text",
      "name": "text",
      "periodDays": 1,
      "usedAmountUsd": "text"
    }
  ]
}

GetAccountWithdrawalDestinations handle the request to get all withdrawal destinations for an account

get

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations

Includes destinations in every status (pending and confirmed). Filter client-side if only confirmed ones are needed. Name optionally does a case-insensitive partial match

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

accountIdstringRequired

account_id represents the account identifier

Query parameters

namestringOptional

name optionally filters destinations by name It ignores case and matches any destination that contains the provided name

Responses

200

A successful response.

application/json

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

get/accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations

HTTPcURLJavaScriptPython

GET /accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "destinations": [
    {
      "accountId": "text",
      "country": "text",
      "createdAt": "2026-08-10T22:15:25.577Z",
      "id": "text",
      "identifier": "text",
      "name": "text",
      "payload": {},
      "railCode": "text",
      "railVersion": 1,
      "status": "text",
      "type": "text",
      "updatedAt": "2026-08-10T22:15:25.577Z"
    }
  ]
}

RegisterWithdrawalDestination handle the request to register a withdrawal destination

post

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations

payload's shape depends on rail_code/rail_version — check GetAllRailSchemas to know what fields to send. The destination isn't usable until ConfirmWithdrawalDestination completes verification

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

accountIdstringRequired

account_id represents the account identifier

Body

application/json

namestringRequired

payloadobject · Rail-specific payload (dynamic schema)Required

railCodestringRequired

railVersioninteger · int32Required

Responses

200

A successful response.

application/json

object · RegisterWithdrawalDestinationResponse is the body response structure from the RegisterWithdrawalDestination endpointOptional

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

post/accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations

HTTPcURLJavaScriptPython

POST /accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "name": "text",
  "payload": {},
  "railCode": "text",
  "railVersion": 1
}

{}

DeleteWithdrawalDestination handle the request to delete a withdrawal destination

delete

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations/{destinationId}

Removes the destination whether it's pending or already confirmed

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

accountIdstringRequired

account_id represents the account identifier

destinationIdstringRequired

destination_id represents the withdrawal destination identifier

Responses

200

A successful response.

application/json

object · DeleteWithdrawalDestinationResponse is the body response structure from the DeleteWithdrawalDestination endpointOptional

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

delete/accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations/{destinationId}

HTTPcURLJavaScriptPython

DELETE /accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations/{destinationId} HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Accept: */*

{}

UpdateWithdrawalDestination handle the request to update a withdrawal destination

patch

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations/{destinationId}

Only renames the destination. The rail payload itself can't be changed, register a new destination instead if those details need to change

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

accountIdstringRequired

account_id represents the account identifier

destinationIdstringRequired

destination_id represents the withdrawal destination identifier

Body

application/json

namestringRequired

Responses

200

A successful response.

application/json

object · UpdateWithdrawalDestinationResponse is the body response structure from the UpdateWithdrawalDestination endpointOptional

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

patch/accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations/{destinationId}

HTTPcURLJavaScriptPython

PATCH /accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations/{destinationId} HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{}

ConfirmWithdrawalDestination handle the request to confirm a withdrawal destination

post

https://backend.pay.kiichain.iohttps://backend.pay.staging.kiichain.io

/accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations/{destinationId}:confirm

verify_code is the one-time code sent out after RegisterWithdrawalDestination — moves the destination from pending to confirmed

Required scopes

This endpoint requires the following scopes:

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Send 'Authorization: APIKey ' to authenticate with a API key.

Path parameters

userIdstringRequired

user_id represents the user identifier

accountIdstringRequired

account_id represents the account identifier

destinationIdstringRequired

destination_id represents the withdrawal destination identifier

Body

application/json

verifyCodestringRequired

Responses

200

A successful response.

application/json

object · ConfirmWithdrawalDestinationResponse is the body response structure from the ConfirmWithdrawalDestination endpointOptional

default

An unexpected error response. details[0] is always an AppError, see #/components/schemas/AppError

application/json

post/accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations/{destinationId}:confirm

HTTPcURLJavaScriptPython

POST /accounts/v1/users/{userId}/accounts/{accountId}/withdrawal_destinations/{destinationId}:confirm HTTP/1.1
Host: backend.pay.kiichain.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "verifyCode": "text"
}

{}