EasyOFAC API

Build enterprise-class OFAC compliance into your application with our easy to understand API.



api/tokenSearch

Perform a tokenized fuzzy search across all lists

Metered Endpoint

Usage of this endpoint counts towards your billable usage. Remember you can append 'test=1' to any query, switching to test mode. This will limit your search to OFAC entity numbers ≤ 4000, but will not count towards your account's billable usage. For your testing purposes, we have provided a list of all SDN records that should be visible in test mode here: EasyOFAC SDN Test List (CSV format).

Parameters

Required Parameters
api_key
Your API key
name
Search term
type
The type of records to include: "all", "customer", "company"
related
Include all related records, with entity as the root record (defaults to enabled/true). Set to "0" or "1".

Response

Response Object

Returns {array}

The returned array may contain any number of objects of type OfacSdn, OfacAlt:

OfacSdn
type
Object type (always set to "OfacSdn")
ofac_sdn_ent_num
OFAC Entity Number
ofac_sdn_name
Name
ofac_sdn_type
Type
ofac_sdn_program
OFAC Program
ofac_sdn_title
Title
ofac_sdn_call_sign
Call Sign
ofac_sdn_vess_type
Vessel Type
ofac_sdn_tonnage
Tonnage
ofac_sdn_grt
Grt
ofac_sdn_vess_flag
Vessel Flag
ofac_sdn_vess_owner
Vessel Owner
ofac_sdn_remarks
Remarks

OfacAlt
type
Object type (always set to "OfacAlt")
ofac_alt_ent_num
OFAC Entity Number
ofac_alt_num
Alternate Name Entity Number
ofac_alt_type
Type
ofac_alt_name
Name
ofac_alt_remarks
Remarks

Notes

This search uses fuzzy matching to look for records containing ALL the given tokens with any placement within the entity name. Fuzzy searching allows you to check for different spellings that are phonetically similar. For example, try the above search ag ain, replacing "GONZALEZ" with "GONZOLEZ". Also, try experimenting to get an idea of how far off the spelling can get before you no longer get a match returned.

Try It

Try it yourself... Feel free to change the parameters to test out different values.

Note: The Demo API Key always operates in test mode. Disabling test mode for a different key will enable logging for this paid endpoint.

Full URL

Request

                        
                    

Result

                        
                    

Support

For more information on using this API, or to suggest new features, please feel free to contact us.

EasyOFAC, Inc.

An OpenACH Company
401 E 8th St, Ste 214-694
Sioux Falls, SD 57103
Tel: 605.301.4959
Email: info@easyofac.com

Drop Us A Line


© Copyright 2024 EasyOFAC and OpenACH, Inc. All rights reserved. Design by blacktie.co