Codes · min plan: developer · lightweight (0.1u) · scope: read:master · both

Country Codes

Returns alpha-2, alpha-3, numeric, region, and customs-alias metadata.

GET /v1/master/countries

Required scope

read:master

API credits

0.1 per success

Minimum plan

developer

Rate-limit bucket

lightweight

Parameters

Name	In	Type	Required	Description
code	query	string	—	Alpha-2 or alpha-3 code.

Sample request

curl "https://getway.clearie.neximprove.com/v1/master/countries?code=IN" -H "Authorization: Bearer $CLEARIE_API_KEY"

Sample response

{
  "items": [
    {
      "code": "IN",
      "iso3": "IND",
      "name": "India",
      "region": "Asia"
    }
  ],
  "meta": {
    "weighted_units": 0.1
  }
}

Live response contract

Live calls require API-key authentication, read:master scope, plan access, and available quota. Successful calls consume 0.1 API credits.

Sandbox sample response

Workspace try-it calls use isolated representative sandbox records. They are for integration validation, not production filing.

Error examples

401 invalid key · 403 missing scope or plan · 429 quota/rate limit · 404 no verified data where applicable.

Response schema

root object {

items* array [

item object {

code* string// e.g. "IN"

iso3* string// e.g. "IND"

name* string// e.g. "India"

region* string// e.g. "Asia"

}

]

meta* object {

weighted_units* number// e.g. 0.1

}

Try this API live in the workspace

The in-app try-it console runs against the isolated deterministic sandbox repository. It never reads live customer or reference records.

Open in workspace Create account