ClearIP Documentation

Configuration

View Country Name

The ClearIP API references each country by its unique ID defined within ClearIP. To obtain the corresponding human-readable country name, a request with the country ID must be made.

Method: GET URL: https://api.clearip.com/countries/CLEARIP_COUNTRY_ID_HERE

Response Body:

{
  "countries": [
    {
      "id": "CLEARIP_COUNTRY_ID_HERE",
      "name": "COUNTRY_NAME_HERE",
      "code": "COUNTRY_CODE_HERE",
      "isoAlpha2": "2_CHARACTER_ISO_CODE_HERE",
      "isoAlpha3": "3_CHARACTER_ISO_CODE_HERE ",
      "isoNumeric": "NUMERIC_ISO_CODE_HERE"
    }
  ]
}

Example Request: View Country Names for Set of Country IDs

Method: GET URL: https://api.clearip.com/countries?ids%5B%5D=99999999-9999-4999-9999-999999999999&ids%5B%5D=99999999-9999-4999-9999-999999999999&ids%5B%5D=99999999-9999-4999-9999-999999999999&ids%5B%5D=99999999-9999-4999-9999-999999999999

Example Response: View Country Name for Specific Country IDs

{
  "countries": [
    {
      "id": "99999999-9999-4999-9999-999999999999",
      "name": "Canada",
      "code": "1",
      "isoAlpha2": "CA",
      "isoAlpha3": "CAN",
      "isoNumeric": "124"
    },
    {
      "id": "99999999-9999-4999-9999-999999999999",
      "name": "United States",
      "code": "1",
      "isoAlpha2": "US",
      "isoAlpha3": "USA",
      "isoNumeric": "840"
    },
    {
      "id": "99999999-9999-4999-9999-999999999999",
      "name": "Unknown",
      "code": "",
      "isoAlpha2": "",
      "isoAlpha3": "",
      "isoNumeric": ""
    },
    {
      "id": "99999999-9999-4999-9999-999999999999",
      "name": "Belgium",
      "code": "32",
      "isoAlpha2": "BE",
      "isoAlpha3": "BEL",
      "isoNumeric": "056"
    }
  ]
}

View Location Name

A location refers to a U.S. state or Canadian territory or province. The ClearIP API references each location by its unique ID defined within ClearIP. To obtain the corresponding human-readable location name, a request with the location ID must be made.

Method: GET URL: https://api.clearip.com/locations/CLEARIP_LOCATION_ID_HERE

Response Body:

{
  "locations": [
    {
      "createdAt": CREATED_AT_UNIX_TIME_HERE,
      "updatedAt": UPDATED_AT_UNIX_TIME_HERE,
      "id": "CLEARIP_LOCATION_ID_HERE",
      "name": "LOCATION_NAME_HERE",
      "isoCode": "ISO_CODE_HERE",
      "country": "CLEARIP_COUNTRY_ID_HERE"
    }
  ]
}
Configuration