Query OFAC

Returns the OFAC Match Codes.


URL:

https://<FQDN>/v1/clients/<ClientIDISO>/ofac


Request:

JSON Name Value Required Default Description
name object R Name
first String R First Name
last String R Last Name
address object O Address
requestID String
up to 32 Characters
O WatchDog Request Identifier
This is Required if the Bank requires the use of WatchDog
birthYear String
YYYY Format
O Birth Year
This is Optional if the Bank requires the use of WatchDog
country String
3-digit code
O ISO 3166-1 Country Code
This is Optional if the Bank requires the use of WatchDog

Sample requests:

Pack your Request, the following Samples shown here are unpacked only for human readability:

Query OFAC:

{
  "name":
  {
    "first": "John",
    "last": "Smith"
  }
}

-----
Query OFAC (using WatchDog):
{
  "name":
  {
    "first": "John",
    "last": "Smith"
  },
  "requestID": "ABC123"
}

Response:

Status Codes:

Status Code Description
200 OK The OFAC Match Codes are returned.
207 Multi-Status Unable to contact WatchDog.

See Status Codes for other possible Status Codes that might be returned.


Response Data:

JSON Name Value Description Status Code
200 207 Other
SC Integer
3-digit code
HTTP Status Code O
EC String
1 or 8 characters
Internal Error Code O
EM String Error Message O O
ofacMatchCodes String OFAC Match Codes
ofacValue String OFAC Value to be used in Create Transaction
errors Array of
8 characters
Strings
Array of Internal Error Codes

Sample responses:

Query OFAC:
{
  "SC": 200,
  "EC": "0",
  "ofacMatchCodes": "LN",
  "ofacValue": "7nGfHHedKNe1aw"
}

-----
Query OFAC (using WatchDog):
{
  "SC": 200,
  "EC": "0",
  "ofacMatchCodes": "H",
  "ofacValue": "8oHgIIfeLOf2bx"
}

Notes:

For Clients who are an ISO (Independent Sales Organization), to specify your ClientID and a SubClientID, use the underscore character ("_") to separate the two values: <ClientID>_<SubClientID> where:

  • ClientID is your unique 22-character string and
  • SubClientID is an assigned 4, 6 or 8-digit value.

OFAC Match Codes Description
LN Last Name did Not Match
LM Last Name Matched, but First Name did Not Match
LMFM Last Name Matched and First Name Matched
LMFP Last Name Matched, but First Name was just a Partial Match
LMFO Last Name Matched, but First Name was just a Partial (out of order) Match
LP Last Name was just a Partial Match and First Name did Not Match
LPFM Last Name was just Partial Match, but First Name Matched
LPFP Last Name and First Name were both just a Partial Match
LPFO Last Name partial Match and First Name Out Of Order
LOFM Last Name was just a Partial (out of order) Match, but First Name Matched
LOFP Last Name was just a Partial (out of order) Match and First Name was just a Partial Match
LOFO Last Name and First Name were both just a Partial (out of order) Match
 
N No Hit
H Hit
HN Hit by Name

Please speak to your Bank to determine if this is required in Create Transaction.