RESTful API Documentation

Everything you need to integrate the OFAC Search API

Swagger UI

Explore and test the API interactively via Swagger:

Swagger

Swagger allows you to try live requests using your API Key and OFAC ID. Make sure to authorize before sending requests.

Sample Request Payload


	{
	"OFAC ID": 12345,
	"API Key": "your-api-key",
	"word1": "John",
	"word2": "Doe",
	"city": "New York",
	"country": "USA",
	"postalCode": "10001",
	"searchComments": "Initial screening"
	}

Minimum 3 characters required across all fields. ofacId is mandatory.

You may include additional fields such as state, address, or dateOfBirth NOTE: This fields will not always change search results as the OFAC/Other lists do not always include this type of data. These fields are included on the reports/XML Output.

Authentication

Use your OFAC ID and API Key from Settings Page.

These credentials must be included in every request. If either is missing or invalid, the API will return a 400 error OR Invalid Search Key.

Lists to Search

Select the list(s) to search using the following codes:

Use 0 for the broadest search coverage unless your use case requires a specific jurisdiction.

Data Type

Specify the type of data being searched:

Use 3 if you're unsure whether the subject is a person or entity. For specific search, use types 41–45.

Name Parsing

Split the search term into up to five components:

Example 1:
Input: "John Smith"
Output: word1 = John, word2 = Smith, word3–5 = blank

Example 2:
Input: "IRAN PETROCHEMICAL COMMERCIAL COMPANY"
Output: word1 = IRAN, word2 = PETROCHEMICAL, word3 = COMMERCIAL, word4 = COMPANY, word5 = blank

Avoid including punctuation or special characters in name fields. Use uppercase or lowercase freely—matching is case-insensitive.

Address Fields

NOTE: These fields will not always change search results as the OFAC/Other lists do not always include this type of data. These fields are included on the reports/XML Output.

Date of Birth

Include date of birth in the format MM-DD-YYYY.

Partial dates (e.g., year only) are supported supported.

NOTE: This field will not always change search results as the OFAC/Other lists do not always include Date of Birth. These fields are included on the reports/XML Output.

Search Comments

Optional comments for internal use. This is not searched but will appear in the generated report Data.

Use this field to track the purpose of the search or associate it with a case ID.

Response Fields

The Found value indicates the number of potential matches. Use the OFAC ID and Search Key to retrieve full reports.

Report Retrieval

Use the returned OFAC ID and Search Key to retrieve reports:

These links are dynamically generated. Replace the ofacId and searchKey with values from your response.