This page is the primary reference for both response structure and field-level definitions for the Country Risk response.
This dictionary documents the full potential response shape.
At runtime:
- properties that evaluate to
nullmay 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
The response is typically returned as a single object with three top-level sections:
correlationIdcountryrisk
Within risk, indicator groups are returned as nested objects:
countryRiskIndicatorAmlcountryRiskIndicatorEsgcountryRiskIndicatorSovereigncountryRiskIndicatorSupplyChainRisk
Within risk, additional non-indicator properties may also be returned, including:
oecdMemberworldBankClassification
These indicator groups represent the full available model, but a runtime response may include only the groups for which data is available.
| Property | Type | Nullable | Meaning | Example |
|---|---|---|---|---|
correlationId | string (uuid) | No | Request tracing ID. | f563b6bc-549f-4d4a-95bc-c658b407bd2f |
country | object | No | Country identity and location metadata. | { "countryCodeIso2": "MF", ... } |
risk | object | No | Risk indicator group container. | { "oecdMember": false, ... } |
| Property | Type | Nullable | Meaning | Example |
|---|---|---|---|---|
country.countryCodeIso2 | string | No | ISO 3166-1 alpha-2 country code. | MF |
country.countryCodeIso3 | string | No | ISO 3166-1 alpha-3 country code. | MAF |
country.countryName | string | No | Display country name. | Saint Martin (French part) |
country.region | string | No | Region grouping for the country. | Americas |
These properties exist directly under risk and are not part of the four indicator families.
| Property | Type | Nullable | Meaning | Example |
|---|---|---|---|---|
risk.oecdMember | boolean | No | Indicates whether the country is an OECD member. | false |
risk.worldBankClassification | string | Yes | World Bank income classification for the country. | High income |
Available values for risk.worldBankClassification:
High incomeUpper middle incomeLower middle incomeLow incomeUnclassified
These fields are common to AML, ESG, Sovereign, and Supply Chain indicator objects.
| Property Suffix | Type | Nullable | Meaning | Example |
|---|---|---|---|---|
.score | number | Yes | Risk score from 0 to 100 (higher means higher risk). | 42.86 |
.riskClassificationCategorical | string | null | Yes | Risk band (Very Low to Very High). | High |
.riskClassificationNumeric | integer | Yes | Numeric risk band value. | 4 |
.countryRank | integer | Yes | Global rank where 1 is lowest risk. | 154 |
.countryUniverse | integer | Yes | Number of countries included in that indicator model. | 249 |
.dataQualityCategorical | string | null | Yes | Data quality label (Very Good to Very Poor or Not Available). | Poor |
.dataQualityNumeric | integer | Yes | Numeric data quality value (1 best, 5 worst). | 2 |
| Property | Type | Nullable | Meaning | Example |
|---|---|---|---|---|
risk.countryRiskIndicatorAml.euHighRiskFlag | boolean | Yes | Country appears on EU high-risk list. | false |
risk.countryRiskIndicatorAml.fatfHighRisk | boolean | Yes | Country appears on FATF high-risk list (black list). | false |
risk.countryRiskIndicatorAml.fatfIncreasedMonitoring | boolean | Yes | Country appears on FATF increased monitoring list (grey list). | false |
Fields are documented as nullable for schema completeness.
At runtime, properties that evaluate to null may be omitted from API responses.
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.