Skip to content

Countries of person

Preview

This feature is not subject to our service terms. Pre-GA features are available as is and might have limited support.

List of all countries discovered for the person in this job.

Schema

The job's payload.countries property is an array of type CountryV2.

A CountryV2 object represents a country in context of Modigie APIs which is based on the ISO 3166-1 standard.

In requests, it is required to provide exactly one of alpha2, alpha3, num3, or title.

A CountryV2 object has properties as described below:

alpha2: string

The ISO 3166-1 alpha-2 code representing this country.

For example, the two uppercase letters "US" represent the United States of America, "CA" represent Canada.

alpha3: string

The ISO 3166-1 alpha-3 code representing this country.

For example, the three uppercase letters "USA" represent the United States of America, "CAN" represent Canada.

num3: string
pattern: '^\d{3}'

The ISO 3166-1 numeric-3 code representing this country.

For example, the three digits "840" represent the United States of America, "044" represent Bahamas.

title: string
Display name of country.
officialName: string
Official name of country.

Example

job-response.json
{
  "payload": {
    "countries": [
      {
        "title": "United States",
        "alpha2": "us",
        "alpha3": "usa",
        "num3": "840",
        "officialName": "United States of America"
      }
    ],
    ...
  },
  ...
}

Schema: CountryV2