Field Type Constraints
ofacId*integer ($int32)OFAC ID from Settings Page.
apiKey*stringAPI Key from Settings Page.
listsToSearch integer ($int32) Select the list(s) to search using the following codes:
  • 0 = Search All Lists
  • 1 = OFAC Only
  • 2 = U.S. Lists Only
  • 3 = Non U.S. Lists
  • 4 = BIS Only
  • 5 = OSFI Only
  • 6 = HMS Only
  • 7 = EU Only
  • 8 = UN Only

Use 0 for the broadest search coverage unless your use case requires a specific jurisdiction.
dataType integer ($int32) Specify the type of data being searched:
  • 1 = Person
  • 2 = Entity
  • 3 = Person or Entity
  • 41 = Drivers License Number
  • 42 = ID Number
  • 43 = Passport Number
  • 44 = VIN/Vessel/Aircraft Number
  • 45 = Electronic Address
  • 49 = Other/Unknown

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

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
word2string
word3string
word4string
word5string
addressstringNOTE: 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.
citystring
stProvstring
postalCodestring
countrystring
dobstringDate of birth in the format MM-DD-YYYY
searchCommentsstringOptional comments for internal use. This is not searched but will appear in the generated report Data.