EasyOFAC API
Build enterprise-class OFAC compliance into your application with our easy to understand API.
api/addCustomer
Add a customer to be monitored
Free Endpoint
This endpoint does not count towards your account's billable usage, however the one call per second limit remains in place for free API keys.
Parameters
Required Parameters
api_key
Your API key
id
ID by which you refer to the customer
first_name
First Name
last_name
Last Name
kyc
Has this customer passed a KYC check? (1 = true, 0 = false)
Optional Parameters
taxid_hash
MD5 hash of customer's tax ID number
Response
Response Object
Returns {object}
The returned object will have the following fields:
id
Customer ID
customer_datetime
Date/time when this customer was added
customer_status
Current screening status of this customer ('safe','unsafe','inspect','exception'). Note that a customer marked as 'inspect' means there is a potential match and you should call inspectCustomer or log in to handle the flagged record.
customer_kyc
Has this customer passed a KYC check? (1 = true, 0 = false)
first_name
The first name, as monitored
last_name
The last name, as monitored
Notes
Try It
Try it yourself... Feel free to change the parameters to test out different values.
Full URL
Request
Result
Support
For more information on using this API, or to suggest new features, please feel free to contact us.