Skip to content
Last updated

Country Risk Field Dictionary

This page is the primary reference for both response structure and field-level definitions for the Country Risk response.

Important Runtime Behaviour

This dictionary documents the full potential response shape.

At runtime:

  • properties that evaluate to null may be omitted from the API response
  • indicator objects may be omitted entirely when no data is available for that indicator family
  • missing properties or missing indicator groups should be treated as not available for that country context

Response Shape

The response is typically returned as a single object with three top-level sections:

  • correlationId
  • country
  • risk

Within risk, indicator groups are returned as nested objects:

  • countryRiskIndicatorAml
  • countryRiskIndicatorEsg
  • countryRiskIndicatorSovereign
  • countryRiskIndicatorSupplyChainRisk

Within risk, additional non-indicator properties may also be returned, including:

  • oecdMember
  • worldBankClassification

These indicator groups represent the full available model, but a runtime response may include only the groups for which data is available.

Top-Level Fields

PropertyTypeNullableMeaningExample
correlationIdstring (uuid)NoRequest tracing ID.f563b6bc-549f-4d4a-95bc-c658b407bd2f
countryobjectNoCountry identity and location metadata.{ "countryCodeIso2": "MF", ... }
riskobjectNoRisk indicator group container.{ "oecdMember": false, ... }

Country Fields

PropertyTypeNullableMeaningExample
country.countryCodeIso2stringNoISO 3166-1 alpha-2 country code.MF
country.countryCodeIso3stringNoISO 3166-1 alpha-3 country code.MAF
country.countryNamestringNoDisplay country name.Saint Martin (French part)
country.regionstringNoRegion grouping for the country.Americas

Risk Container Fields (Non-Indicator)

These properties exist directly under risk and are not part of the four indicator families.

PropertyTypeNullableMeaningExample
risk.oecdMemberbooleanNoIndicates whether the country is an OECD member.false
risk.worldBankClassificationstringYesWorld Bank income classification for the country.High income

Available values for risk.worldBankClassification:

  • High income
  • Upper middle income
  • Lower middle income
  • Low income
  • Unclassified

Shared Indicator Fields

These fields are common to AML, ESG, Sovereign, and Supply Chain indicator objects.

Property SuffixTypeNullableMeaningExample
.scorenumberYesRisk score from 0 to 100 (higher means higher risk).42.86
.riskClassificationCategoricalstring | nullYesRisk band (Very Low to Very High).High
.riskClassificationNumericintegerYesNumeric risk band value.4
.countryRankintegerYesGlobal rank where 1 is lowest risk.154
.countryUniverseintegerYesNumber of countries included in that indicator model.249
.dataQualityCategoricalstring | nullYesData quality label (Very Good to Very Poor or Not Available).Poor
.dataQualityNumericintegerYesNumeric data quality value (1 best, 5 worst).2

AML-Specific Fields

PropertyTypeNullableMeaningExample
risk.countryRiskIndicatorAml.euHighRiskFlagbooleanYesCountry appears on EU high-risk list.false
risk.countryRiskIndicatorAml.fatfHighRiskbooleanYesCountry appears on FATF high-risk list (black list).false
risk.countryRiskIndicatorAml.fatfIncreasedMonitoringbooleanYesCountry appears on FATF increased monitoring list (grey list).false

General Runtime Behaviour

Fields are documented as nullable for schema completeness.

At runtime, properties that evaluate to null may be omitted from API responses.

Interpreting Missing Properties

If a nullable property is not present in a runtime response, treat it as not available for that country/indicator context.

Common reasons include:

  • Data coverage below confidence threshold
  • Ranking not produced for that country in that indicator model
  • Classification could not be reliably produced

When score is absent or null, do not use that indicator for direct country-to-country score/rank comparisons.