API Documentation

This API is a REST/JSON type webservice, and is defined by a set of endpoints, each one serving a specific function. The following documents the purpose of each endpoint, what parameters are required, and what you can expect in return.

Endpoints

quota

Check the number of remaining searches on your API Key's quota.

stats

View usage statistics for the past 24 hours.

nameSearch

Perform a fuzzy search for an individual on the OFAC SDN List.

companySearch

Perform a fuzzy search for a company on the OFAC SDN List.

addSearch

Search for address records matching the given search criteria.

altSearch

Search for alternate name records matching the given search criteria.

sdnSearch

Search for SDN records matching the given search criteria.

adds

Retrieve a complete list of address records given a SDN entity number.

alts

Retrieve a complete list of alternate name records given a SDN entity number.

sdn

Retrieve a single SDN record given its entity number.

Test Mode

Any valid API key can be used in test mode simply by passing the parameter test with a value of 1 along with the other parameters required by the endpoint. This will do two things. First, the endpoint usage will not be logged and the one-per-second rate limit will be lifted. Second, and most importantly, the result set searched will only include SDN records with entity numbers ≤ 1000, which works out to be approximately 2% of the database.