API Responses

The search response interface represents the status and and results of a given search. It returns status in the form of HTTP response codes as well as additional status information embedded within the response body. Information about the search performed, such as sources included, are also returned. Finally, the search results themselves whose data structure is defined below.

Note Care should be taken to handle all possible error scenarios in your application code, including HTTP response code and error and errorMessage fields. Failed requests should not be reattempted in a looping fashion. Queries resulting in a 4xx error should not be reattempted.

Important Full API technical specification can be found here OFAC API v3 Swagger UI

Structure

Successful API Response

Note Names sent within the case field of the request structure are mapped to keys within the match field of the response structure.

HTTP 200

{
	"error": boolean,
	"sourcesUsed": [{
		"source": "string",
		"publishDate": "string"
	}],
	"matches": {
		"name": [{
			"source": "string",
			"firstName": "string",
			"lastName": "string",
			"fullName": "string",
			"dob": "string",
			"addresses": [{
				"uid": integer,
				"address1": "string",
				"address2": "string",
				"address3": "string",
				"city": "string",
				"stateOrProvince": "string",
				"postalCode": "string"
				"country": "string"
			}],
			"citizenship": ["string"],
			"uid": Integer,
			"sdnType": "string",
			"remarks": "string",
			"programs": [
				"string"
			],
			"additionalSanctions": [
				"string"
			],
			"passports": [{
				"passport": "string",
				"passportCountry": "string",
			}],
			"score": integer,
			"ids": [{
				"type": "string",
				"id": "string"
			}],
			"akas": [{
				"score": integer,
				"uid": integer,
				"category": "string",
				"lastName": "string"
			}]
		}]
	}
}

Bad Request API Response

HTTP 400

{
	"timestamp": "2020-03-06T20:17:30.735+0000",
	"status": 400,
	"error": "Bad Request",
	"message": "string",
	"path": "string"
}

Invalid API Key

HTTP 401

{
	"error": true,
	"errorMessage": "Invalid API Key"
}

Status Codes

Possible HTTP status codes that should be accounted for.

Code	Status	Description
200	Success	Search was performed successfully and results may be examined.
400	Bad Request	There is a problem with the search request, for example a required field is missing. `errorMessage` will contain additional information. Should not be reattempted
401	Unauthorized	The API account has expired or the accounts rate limit has been exceeded.
500	Internal Error	The API has encountered an unexpected error. `errorMessage` will contain additional information that may be used to alert the support team.

Source Types

A source type represents a sanctions list used when screening an individual or entity. This portion of the result can be used to map a search result back to its origination.

Examples

Example 1 Screening client Mickey Mouse which returned no results.

{
	"error": false,
	"sourcesUsed": [{
		"source": "SDN",
		"publishDate": "06/17/2022"
	}],
	"matches": {
		"Mickey Mouse": []
	}
}

Example 2 Screening client Vladimir Victorovich which returned 2 results

Vadim Viktorovich BULGAKOV
Vladimir Nikolaevich PAVLENKO

{
	"error": false,
	"sourcesUsed": [{
		"source": "SDN",
		"publishDate": "06/17/2022"
	}],
	"matches": {
		"Vladimir Victorovich": [{
				"source": "SDN",
				"firstName": "Vadim Viktorovich",
				"lastName": "BULGAKOV",
				"fullName": "Vadim Viktorovich BULGAKOV",
				"dob": "30 Jan 1969",
				"addresses": [{
					"uid": 34133,
					"stateOrProvince": "Crimea",
					"country": "Ukraine"
				}],
				"citizenship": [],
				"uid": 22203,
				"sdnType": "Individual",
				"gender": "Male",
				"programs": [
					"UKRAINE-EO13660"
				],
				"additionalSanctions": [],
				"passports": [],
				"score": 91,
				"akas": [],
				"ids": [{
					"type": "Secondary sanctions risk:",
					"id": "Ukraine-/Russia-Related Sanctions Regulations, 31 CFR 589.201 and/or 589.209"
				}]
			},
			{
				"source": "SDN",
				"firstName": "Vladimir Nikolaevich",
				"lastName": "PAVLENKO",
				"fullName": "Vladimir Nikolaevich PAVLENKO",
				"dob": "14 Apr 1962",
				"addresses": [{
					"uid": 35667,
					"city": "Donetsk",
					"stateOrProvince": "Donetsk Oblast",
					"country": "Ukraine"
				}],
				"citizenship": [],
				"title": "Minister of State Security of the so-called Donetsk People's Republic",
				"uid": 23581,
				"sdnType": "Individual",
				"remarks": "(Linked To: DONETSK PEOPLE'S REPUBLIC)",
				"gender": "Male",
				"programs": [
					"UKRAINE-EO13660"
				],
				"additionalSanctions": [],
				"passports": [],
				"score": 96,
				"akas": [{
						"score": 57,
						"uid": 37195,
						"category": "strong",
						"lastName": "PAVLENKO",
						"firstName": "Volodymyr Mykolaiovych"
					},
					{
						"score": 96,
						"uid": 49506,
						"category": "strong",
						"lastName": "PAVLENKO",
						"firstName": "Vladimir Viktorovich"
					},
					{
						"score": 65,
						"uid": 49507,
						"category": "strong",
						"lastName": "PAVLENKO",
						"firstName": "Volodymyr Viktorovich"
					}
				],
				"ids": [{
					"type": "Secondary sanctions risk:",
					"id": "Ukraine-/Russia-Related Sanctions Regulations, 31 CFR 589.201 and/or 589.209"
				}]
			}
		]
	}
}