Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Supported Countries

List Supported Countries

Retrieves a list of allowed countries for which users can be onboard from.

get/countries

Query parameters

status'ACTIVE' | 'INACTIVE' required

Filters on the returned countries list has inactive or active countries inside it.

Response

Retrieving a list of Supported Countries was Successful.

idstring

The abbreviated identifier of a country.

namestring

The full name of the country

code2string

An alternative abbreviated identifier of a country.

code3string

An alternative abbreviated identifier of a country.

activeboolean

True, if a user can be onboarded from this country.

expatsAllowedboolean

True, if a user who resides outside of their country can be onboarded from the listed country.

foreignTINNotRequiredboolean

True, if a user's tax identifier is NOT required during onboarding.

fpslProhibitedboolean
supportDomicileboolean
taxTreatyCountryboolean

True, if the country has a tax treaty with the United States.

Example response

[
  {
    "id": "ALA",
    "name": "Aland Islands",
    "code2": "AX",
    "code3": "ALA",
    "active": true
  }
]