EasyOFAC API

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

api/updateCustomerStatus

Update a customer's status to 'safe', 'unsafe' or 'exception'. Possible use cases might be: After reviewing potential matches on a customer with a status of 'inspect', mark the customer as an 'exception' (in the case where the potential match was a false positive), or 'unsafe' (in the case where the potential match was correct). A customer marked as 'exception' or 'unsafe' may be updated to 'safe', which will automatically trigger a reverification of the record. Note that a reverification may result in the record being flagged as 'inspect', in which case you will need to review the potential matches via the inspectCustomer endpoint, or by logging in.

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 by which you refer to the customer

status

The new status of the customer (one of: 'safe','unsafe','exception')

Response

Response Object

Returns {object}

The returned object will have the following fields:

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 log in to handle the flagged record.

customer_kyc

Has this customer passed a KYC check? (1 = true, 0 = false)

Try It

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

api_key

status

Full URL

https://easyofac.com/api/updateCustomerStatus?api_key=SqxD2ynGWKcok1w4SO6JPydthq3S62fL&id=6400242&status=exception

Try It!

Request

Result

Support

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