Get OFAC Investigation Report
Action: POST
Endpoint: /api/CoreCredit/AccountManagement/GetOFACInvestigationReport
Use this API to obtain the details of all OFAC suspicious accounts returned during a Bulk OFAC screening. The OFAC record details are included for all accounts/cardholders within an institution, such as IST score (Threshold Score of OFAC set on Institution), the Name, Address, Account Number, OFAC Match Results, and the last OFAC scan date.
Request fields details
Fields | Description |
---|---|
Source string Mandatory |
Source of API Consumer For external system expected sources will be WEB. Allowable Values: 50 |
IPAddress string Optional |
IP Address of Client / Application Hosting Server Example: 10.206.0.204 Allowable Values: 15 |
DateFormat string Optional |
Place Holder for Future Use. Values are: 1 : MM/dd/yyyy HH:MM:SS (Default) 2 : MM/dd/yy HH:MM:SS 3 : dd/MM/yyyy HH:MM:SS Allowable Values: 25 |
CurrencyCode string Optional |
Currency Code Place Holder for Future Use. Valid Values: Refer Appendix Section - Currency Code Example:840 = US Dollar Condition:If no value is passed, default value = 840 Allowable Values: 10 |
CurrencySymbolType string Optional |
Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD Allowable Values: 10 |
Language string Optional |
Place Holder for Future Use. Language: en: means use English Default: en - English Allowable Values: 10 |
ExternalIP string Mandatory |
IP Address of end user of API Allowable Values: 50 |
SessionID string Optional |
Session identifier of the API Example: 000028;026;1349906692 Allowable Values: 100 |
APIVersion string Mandatory |
Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0 Allowable Values: 10 |
CallerID string Optional |
Caller ID of source from where API is initiated it is End User Caller ID Example: 7204454214 (phone number applicable in Case of IVR) Allowable Values: 20 |
CalledID string Optional |
Called ID of destination for which API is initiated It is Destination Called ID Example: 7314145404 (phone number applicable in Case of IVR) Allowable Values: 20 |
RequestTime datetime Optional |
Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23 |
LastScanDate datetime Mandatory |
Previous Date on which Account screened for OFAC as part of Bulk OFAC screening. Format:MM/DD/YYYY Example:12/20/2019 |
InstitutionID integer Mandatory |
Unique identification number for Institution Valid Values:0-9 Format:XXXX Example:Fixed value needs to pass which is provided by Corecard. |
Sample request body
{ "Source": "Web", "IPAddress": "10.120.0.1", "DateFormat": null, "CurrencyCode": null, "CurrencySymbolType": null, "Language": null, "ExternalIP": "10.120.0.0", "SessionID": null, "APIVersion": "2.0", "CallerID": null, "CalledID": null, "RequestTime": null, "InstitutionID": 3241, "LastScanDate": "12/20/2019 00:00:00" }
Response fields details
Fields | Description |
---|---|
OFACInvestigationReport array |
Array to show OFAC records which are matched/NotMatched with Insitituion threshold. |
InstitutionThreshold string |
Description: Threshold value which is set on Institution for OFAC check. Valid Values: 0-9 Example: 85 Allowable Values: 3 |
LastScanDate string |
Previous Date on which Account screened for OFAC as part of Bulk OFAC screening. Format:MM/DD/YYYY Example:12/20/2019 |
Sample response body
{ "Message": "Success", "Status": true, "ErrorCode": "Err00017", "ResponseData": { "OFACInvestigationReport": [ { "OFACScore": "95", "FirstName": "Alex", "MiddleName": null, "LastName": "user", "AddressLine1": "14 Avenue New one", "AddressLine2": null, "City": "Atlanta", "State": "GA", "Country": "US", "AccountNumber": "8110000000000190", "SecondLastName": null, "MatchFlag": "NotMatch", "AccountManualStatus": "Active", "OFACClearanceDate": null }, { "OFACScore": "95", "FirstName": "CH", "MiddleName": null, "LastName": "CH", "AddressLine1": "12 Avenue New one", "AddressLine2": null, "City": "Atlanta", "State": "GA", "Country": "US", "AccountNumber": "8110000000000117", "SecondLastName": null, "MatchFlag": "NotMatch", "AccountManualStatus": "Active", "OFACClearanceDate": null } ], "InstitutionThreshold": "90", "LastScanDate": "Dec 20 2019 12:00AM" } }