Parameters & Options

The API allows for search customization including response data type, flags to consider alias and entity records and which data sources a search should be performed against.

API options may be passed as HTTP query parameters with an HTTP GET request, or within the request body of an HTTP POST request.

Additional API technical docs can be found here OFAC API v2 Swagger UI

Query Parameters

name

string

REQUIRED - For single search

Full name of entity being screened. For use with standard search API.
Examples: Abu Abas, Central Import & Export

names

string []

REQUIRED - For batch search

Array of names being screened. For use with batch screening API.
Examples: [Abu Abas, Central Import & Export, ...]

id

string

REQUIRED - For ID search

ID sequence of entity being screened.
Note ID parameters that are 5 characters or less require an exact match with the sanctioned entities ID field to be returned, however ID parameters greater than 5 characters are only required to be contained by a sanctioned entities ID field.
For example, an ID query of 9357391 would yield a match of an entity with an ID of IMO 9357391
Examples: "IMO 9357391"

apiKey

string

REQUIRED

Your organizations unique API passed as arequest header, query param or within the request body

format

string

OPTIONAL

Specifies the data format to be returned.
Excepted values XML, JSON
Default JSON

minScore

integer

OPTIONAL

The threshold minimum for record scores to include in results set.
Note Based on OFAC guidelines, the SDN search algorithm assigns each SDN entry a score based on the likelihood of a match. Therefor, the higher the score, the more likely the searched entity matches the given SDN entry. The minScore attribute is used to control the volume of results for a given search, for example a threshold of 50 would most likely return more results than a representative could reasonably analyze. The recommended threshold setting is 80. More on the SDN Search Algorithm can be found here.
Default 80

source

Collection

OPTIONAL

Specifies which data sources this query name should be screened against.
This value should be passed as either an array within the request body of a POST, or as a comma separated string if passes as a query string. The sources used for a given query will be noted in the query response regardless if the response contains results for that source.
Excepted values SDN, NONSDN, DPL, UN
Default SDN

type

Collection

OPTIONAL

Allows filtering based on entity type. This optional field enables you to specify which list entry types to focus on. For example, exclude vessel types when screening an individual submitting remittance.
This value should be passed as either an array within the request body of a POST, or as a comma separated string if passes as a query string.
Excepted values Entity, Individual, Vessel
Default All types

includeAlias

boolean

OPTIONAL

Specifies if entity aliases (AKAs) should be considered when screening this individual. Aliases will be returned as separate entities within a result set if this option is set to true.
Excepted values TRUE, FALSE
Default FALSE

Match Threshold

Match threshold refers to the minimum score to be returned as a potential list match. Each record in the included sanctions lists is given a score when compared to the passed search term and those with a score greater than the match threshold are considered as potential matches.

OFAC API uses a blended Jaro Winkler and Soundex comparison algorithm, taking into account partial perfect matches, differences in name length and total name parts. The search was developed in collaboration with the Department of the Treasury.

Tip A minScore between 80-100 is recommended.

Batch Screening New

Batch screening allows you to execute all of your required queries with a single API request, saving time and resources!

A batch search request is identical to a standard single search request, with the exception of the name to be searched, which is replaced by a collection of names.

A batch search result is also identical to a standard single search result, but with a map of results instead. The map contains an entry for each search name passed, containing the search name as a key and a collection of matches as the value. See the request and response structure below.

Note 1000 search phrases is the recommended batch size limit. Maintaining a match threshold of greater than 90 will help limit the response size if needed.

Batch Request Example

{
	"names": ["Abu Abbas", "Vladimer Petrov", "..."],
	"includeAlias": false,
	"minScore": 90,
	"apiKey": "string",
	"data": "json",
	"source": ["SDN"],
	"type": ["Individual"]
}