Guide to the APIData Types

Working With Country Codes

The FrankieOne service standardizes all country information using ISO-3166-alpha3 codes (e.g., ‘AUS’ for Australia, ‘GBR’ for United Kingdom).

Input Flexibility

When sending country data to our API, you can use any of these formats:

Alpha-3

Three-letter codes (e.g., ‘AUS’)

Alpha-2

Two-letter codes (e.g., ‘AU’)

Full Names

Complete country names (e.g., ‘Australia’)

How It Works

1

Input Processing

The service accepts your country input in any ISO-3166 compliant format

2

Normalization

Automatically converts the input to ISO-3166-alpha3 format

3

Validation

Verifies the converted code against ISO standards

If the service can’t convert your country input to a valid ISO-3166-alpha3 code, the request will be rejected with an error response.

Example Usage

1{
2  "country": "Australia",  // Will be converted to "AUS"
3  "nationality": "AU",     // Will be converted to "AUS"
4  "residency": "AUS"      // Already in correct format
5}

ISO-3166 Country Codes Reference

For a complete list of valid country codes and their formats, refer to the ISO-3166 Country Codes Wikipedia page.

Common examples:

  • 🇦🇺 Australia: AUS (AU)
  • 🇬🇧 United Kingdom: GBR (GB)
  • 🇺🇸 United States: USA (US)
  • 🇨🇦 Canada: CAN (CA)