Get all countries

Retrieve a list of available countries with optional filtering by scope. The scope parameter controls which countries are returned: core (default) returns countries with full operational support, supported returns countries with document definitions, and all returns every country in the system.

get/api/v1/countries

Request

Base URL: https://api-sandbox.koywe.com
URL: https://api-sandbox.koywe.com/api/v1/countries
Auth: none declared

Query parameters

operationalStatus'ENABLED' | 'RESTRICTED' | 'BLOCKED'

Filter countries by operational status

scope'core' | 'supported' | 'all' | 'onboarding'

Filter countries by scope: core (default) for countries with full support (AR, CL, CO, PE, MX, BR, US, BO), supported for countries with document definitions, all for every country in the system

Response

Get countries based on the specified scope

idstring required

namestring required

fullNamestring nullable required

twoLetterIsostring required

operationalStatusstring required

Example response

[
  {
    "id": "ctry_8efa0d0c-f834-42eb-af78-ff4149c2e6ef",
    "Currency": {
      "currency": "ARS",
      "currencyId": "cur_8289dc19-e775-4c0c-a42a-e0da129e3b64"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.