api.duoleads.com

{
  "properties": {
    "data": {
      "description": "found, kind (country|subdivision), alpha_2, alpha_3, numeric, name, official_name (the ISO 3166-1 official name from Debian iso-codes, e.g. \"Kingdom of the Netherlands\"; the short name where ISO defines no separate official name; always a string), m49 {region, region_name, subregion, subregion_name, intermediate, intermediate_name} (UN M49 codes as zero-padded 3-character strings; subregion and intermediate are null where the hierarchy has no such level), currencies [ISO 4217 alpha-3, legal tender in use per CLDR], tld [\".xx\"] (the ccTLD in actual use, so GB gives .uk; empty where none is delegated), subdivision_count (always present: the number of ISO 3166-2 subdivisions), and with include=subdivisions subdivisions [{code, name, type, parent}] (ISO 3166-2 from Debian iso-codes main of 2026-09-28, source order; parent is the parent subdivision code or null; countries with none return an empty list). A code of the form CC-XXX (e.g. NL-NH) resolves a subdivision: kind is subdivision, subdivision {code, name, type, parent} is added, and the country fields describe its country. m49, currencies and tld are omitted when not named in include; subdivision_count is not. A name search adds matches [{alpha_2, alpha_3, numeric, name}] (exact name first, then substring; at most 25) plus total_matches, and the top-level fields describe the first match. ZZ and other non-ISO codes are never found.",
      "properties": {
        "alpha_2": {
          "type": "string"
        },
        "alpha_3": {
          "type": "string"
        },
        "currencies": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "found": {
          "type": "boolean"
        },
        "kind": {
          "type": "string"
        },
        "m49": {
          "properties": {
            "intermediate": {
              "type": [
                "string",
                "null"
              ]
            },
            "intermediate_name": {
              "type": [
                "string",
                "null"
              ]
            },
            "region": {
              "type": [
                "string",
                "null"
              ]
            },
            "region_name": {
              "type": [
                "string",
                "null"
              ]
            },
            "subregion": {
              "type": [
                "string",
                "null"
              ]
            },
            "subregion_name": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "region",
            "region_name",
            "subregion",
            "subregion_name",
            "intermediate",
            "intermediate_name"
          ],
          "type": "object"
        },
        "matches": {
          "items": {
            "properties": {
              "alpha_2": {
                "type": "string"
              },
              "alpha_3": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "numeric": {
                "type": "string"
              }
            },
            "required": [
              "alpha_2",
              "alpha_3",
              "numeric",
              "name"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "name": {
          "type": "string"
        },
        "numeric": {
          "type": "string"
        },
        "official_name": {
          "type": "string"
        },
        "subdivision": {
          "properties": {
            "code": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "parent": {
              "type": [
                "string",
                "null"
              ]
            },
            "type": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "name",
            "type",
            "parent"
          ],
          "type": "object"
        },
        "subdivision_count": {
          "type": "integer"
        },
        "subdivisions": {
          "items": {
            "properties": {
              "code": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "parent": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "required": [
              "code",
              "name",
              "type",
              "parent"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "tld": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "total_matches": {
          "type": "integer"
        }
      },
      "required": [
        "found"
      ],
      "type": "object"
    },
    "meta": {
      "$ref": "#/components/schemas/Meta"
    },
    "ok": {
      "const": true
    },
    "route": {
      "const": "/v1/ref/country"
    },
    "version": {
      "const": "1.0.0"
    }
  },
  "required": [
    "ok",
    "route",
    "version",
    "data",
    "meta"
  ],
  "type": "object"
}