EasyOFAC API

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

api/getCustomers

Search for customer records matching the given search criteria.

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

Optional Parameters

page

For pagination, a zero-based page index, default 0

count

For pagination, the number of records to return, default 50

Response

Response Object

Returns {array}

The returned array may contain any number of objects of type Customer:

Customer

type

Object type (always set to "Customer")

Customer ID

customer_datetime

Updated

customer_status

Status

customer_kyc

Passed a KYC Screening

Notes

This endpoint returns all customers. The results are paginated, and can be adjusted by passing the optional count and page parameters. The page parameter is a zero based index of the pages - that is a value of 0 refers to the first page. The count (page size) parameter defaults to 50.

Try It

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

api_key

page

count

Full URL

https://easyofac.com/api/getCustomers?api_key=SqxD2ynGWKcok1w4SO6JPydthq3S62fL&page=0&count=50

Try It!

Request

Result

Support

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