API Request
Each API request must contain authentication in the form of an apiKey
request parameter
or header, and the list of cases to be searched.
You can optionally specify which sanction lists to search against with the sources
parameter, and filter
your result set by type with the type
parameter.
POST https://api.ofac-api.com/v4/search
Required Content Type Header
A Content-Type
header of application/json
is required.
Learn more about Conent-Type Headers (opens in a new tab).
Request Object
Parameters
apiKey
string REQUIRED
Your unique API key.
Note This may also be passed via apiKey
header.
sources
string array
Specifies which sanction lists to search. Passed in the form of an array of sanction list ID codes.
See Data Sources for a listing of all sanction lists and their ID codes.
Example: a value of ["SDN", "EU"]
searches against the OFAC SDN and EU Financial Sanctions lists.
cases
array of case
objects
The case or cases to search for within the sanction datasets.
Note Maximum of 500 cases for batch requests.
Case Object
case.name
string REQUIRED
Full name of the entity being searched.
case.id
string RECOMMENDED
A unique ID used to map results back to this case in the API response. This is especially
useful for batch requests.
-
If provided, the
id
field is copied to the result, allowing the result to be mapped back to the case it is related to. -
If
id
is not provided, mapping must be done using thename
field, which may be problematic if a case name contains an unsupported character that has been formatted by the API.
case.cryptoId
string
Crypto wallet ID
case.address
Address
Note address
is a strong field, meaning a match may be returned based only on it.
Address Object
address.address1
string
address.address2
string
address.city
string
address.stateOrProvince
string
address.postalCode
string
address.country
string
identification
array of Identification
objects
An Identification
can represent any form of ID. For example - passport, tax ID (TIN), drivers license,
social credit ID, military ID, etc.
Note Identification
items are searched based on idNumber
and country
, while
type
is provided for additional context.
Therefore a sanction match may be returned with a matching idNumber
but different a type
value.
Identification Object
idNumber
string
type
string
country
string
{
"apiKey": "your-api-key",
"sources": [
"SDN", "NONSDN", "UK"
],
"types": [
"person", "organization", "vessel", "aircraft"
],
"cases": [
{
"id": "string",
"name": "string",
"idNumber": "string",
"cryptoId": "string",
"address": {
"address1": "string",
"address2": "string",
"city": "stringgo",
"stateOrProvince": "string",
"postalCode": "string",
"country": "string"
}
}
]
}