EasyOFAC API

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



api/inspectCustomer

Inspect the specified customer, and return any potential matches found along with all related records.

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

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 log in to handle the flagged record.
customer_kyc
Has this customer passed a KYC check? (1 = true, 0 = false)
matches
Any number of matched records. Each record will have a 'type' field indicating the record type, and an array of related records in the 'related' field (each also having their own 'type' field).

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.

EasyOFAC

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

Drop Us A Line


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