SanctionsLookupAPI response
The sanctions screening API response format is returned synchronously and contains matches for each submitted subject.
Response body
The API returns a JSON object with top-level metadata and results. Each item in results corresponds to one submitted subject and contains zero or more ranked matches.
{
"metadata": {
"timestamp": "2026-04-21T13:12:28Z",
"min_score": 80
},
"results": [
{
"subject_ref": "client_123",
"matches": [
{
"score": 100,
"matched_subject": {
"type": "INDIVIDUAL",
"primary_name": "Kim Jong Un",
"personal_details": {
"date_of_birth": ["1984-01-08"],
"title": ["Chairman of the Workers' Party of Korea"]
},
"locations": [
{
"country": "Korea, North",
"country_code": "KP"
}
],
"sanction_details": [
{
"type": "secondary_sanctions_risk",
"value": "North Korea Sanctions Regulations, sections 510.201 and 510.210"
},
{
"type": "transactions_prohibited_usfi_owned_controlled",
"value": "North Korea Sanctions Regulations section 510.214"
}
]
},
"match_reasons": ["Exact primary name match"],
"sanctions": [
{
"source": "OFAC",
"list": "SDN List",
"programs": ["DPRK3"],
"measures": ["Block"],
"legal_basis": ["Executive Order 13722 (North Korea)"]
}
]
}
]
}
]
}
Top-level fields
metadata
| Field | Type | Description |
|---|---|---|
| timestamp | string | Response timestamp (UTC) |
| min_score | integer | Applied score threshold |
results
Description: Array of result objects, one per submitted subject.
result object
Description: Each result corresponds to one submitted subject.
| Field | Type | Description |
|---|---|---|
| subject_ref | string | Echoed from request (if provided) |
| matches | array<object> | Ranked matches for the subject |
| subject_query | object | Echoed request subject when options.include_subject_query=true |
subject_ref is present only when sent in the request. matches may be empty when no match meets the score threshold.
match object
Description: Each item in matches represents a potential match.
| Field | Type | Description |
|---|---|---|
| score | integer | Match confidence (0-100) |
| match_reasons | array<string> | Explanation of the match |
| matched_subject | object | Matched sanctions subject |
| sanctions | array<object> | Associated sanctions entries |
matched_subject
Description: Basic information about the matched subject.
| Field | Type | Description |
|---|---|---|
| type | string | Subject type |
| primary_name | string | Main name |
| aliases | array<string> | Alternate names (if available) |
| identifiers | array<object> | Associated identifiers |
| personal_details | object | Returned for individuals (if available) |
| locations | array<object> | Associated locations (if available) |
| sanction_details | array<object> | Additional sanctions context |
*Fields vary depending on the subject type and available data.
Sanctions object
| Field | Type | Description |
|---|---|---|
| source | string | Sanctions source (e.g. OFAC) |
| list | string | List name (e.g. SDN List) |
| programs | array<string> | Sanctions programs |
| measures | array<string> | Applied measures |
| legal_basis | array<string> | Legal references |
Notes
- Matches are sorted by score (highest first)
- Each subject returns its own matches array
- Fields vary depending on available sanctions data
- Result count is limited by max_results_per_subject