EasyOFAC API

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



api/updateCompanyStatus

Update a company's status to 'safe', 'unsafe' or 'exception'. Possible use cases might be: After reviewing potential matches on a company with a status of 'inspect', mark the company 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 company 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 inspectCompany 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
ID by which you refer to the company
status
The new status of the company (one of: 'safe','unsafe','exception')

Response

Response Object

Returns {object}

The returned object will have the following fields:

id
Company ID
company_datetime
Date/time when this company was added
company_status
Current screening status of this company ('safe','unsafe','inspect','exception'). Note that a company marked as 'inspect' means there is a potential match and you should log in to handle the flagged record.
company_kyc
Has this company passed a KYC check? (1 = true, 0 = false)

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