Core Card Api Quick Start

Get OFAC Results

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetOFACResults

Use this API to obtain the OFAC details for a particular account or cardholder screened as part of Bulk OFAC screening or individual OFAC screening. The API request should be sent using an account number and details such as the last individual OFAC check date or Last bulk OFAC check date or OFAC scores.

Note

This API returns the SDN (Specially Designated Nationals) values for the cardholder screened for the OFAC check.

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
AccountNumber string Conditional	Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AdminNumber/AccountNumber is required. Allowable Values: 19
AdminNumber int64 Conditional	Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AdminNumber/AccountNumber is required.
ApplicantType integer Optional	type of Applicants. Valid Value: 1 = Applicant 2 = Co-Applicant 3 = Cosigner 4 = Secondary Card Format:XXXXX Example: 1 Condition: Default value in Request should be 1-Applicant

Fields

Description

Source

string

Mandatory

Source of API Consumer For external system expected sources will be WEB.

Allowable Values:

IPAddress

string

Optional

IP Address of Client / Application Hosting Server Example: 10.206.0.204

Allowable Values:

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:

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:

CurrencySymbolType

string

Optional

Place Holder for Future Use. CurrencySymbolType: 1: Currency Sign like $ 2: 3 ALPHA Currency Code like USD

Allowable Values:

Language

string

Optional

Place Holder for Future Use. Language: en: means use English Default: en - English

Allowable Values:

ExternalIP

string

Mandatory

IP Address of end user of API

Allowable Values:

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:

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:

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:

RequestTime

datetime

Optional

Request Date Time of API Format: MM/dd/yyyy HH:mm:ss Example:01/15/2020 10:05:23

AccountNumber

string

Conditional

Account number of cardholder. Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AdminNumber/AccountNumber is required.

Allowable Values:

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXXXXXXX Example:7314145404 Condition:At least one of AdminNumber/AccountNumber is required.

ApplicantType

integer

Optional

type of Applicants. Valid Value: 1 = Applicant 2 = Co-Applicant 3 = Cosigner 4 = Secondary Card Format:XXXXX Example: 1 Condition: Default value in Request should be 1-Applicant

Sample request body

{
  "Source": "Web",
  "IPAddress": null,
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.205.0.56",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "8110000000000018",
  "AdminNumber": null,
  "ApplicantType": 1
}

Response fields details

Fields	Description
LastIndividualOFACCheckDate datetime	Previous Date on which Account screened for OFAC. Format:MM/DD/YYYY Example:12/20/2019
LastBulkOFACCheckDate datetime	Previous Date on which Account screened for OFAC as part of Bulk OFAC screening. Format:MM/DD/YYYY Example:12/20/2019
OFACScore integer	Score which is imposed to an Account after OFAC Check via any third party and basis SDNEntries(For Exmaple: ISTWatch). Example:85
SDNEntry1 integer	Value imposed to an Account after OFAC Check via any third party(For Exmaple: ISTWatch). Example:85
SDNEntry2 integer	Value imposed to an Account after OFAC Check via any third party(For Exmaple: ISTWatch). Example:90
SDNEntry3 integer	Value imposed to an Account after OFAC Check via any third party(For Exmaple: ISTWatch). Example:90
SDNEntry4 integer	Value imposed to an Account after OFAC Check via any third party(For Exmaple: ISTWatch). Example:85
SDNEntry5 integer	Value imposed to an Account after OFAC Check via any third party(For Exmaple: ISTWatch). Example:85
ApplicantType integer	type of Applicants. Valid Value: 0-Applicant 1-CoSigner 2-Secondary Card Format:XXXXX Example: 1

Sample response body

{
  "Message": "Success",
  "Status": true,
  "ErrorCode": "Err00017",
  "ResponseData": {
    "LastIndividualOFACCheckDate": null,
    "LastBulkOFACCheckDate": null,
    "OFACScore": null,
    "SDNEntry1": null,
    "SDNEntry2": null,
    "SDNEntry3": null,
    "SDNEntry4": null,
    "SDNEntry5": null,
    "ApplicantType": null,
    "OFACResultList": [
      {
        "OFACScoreNew": null,
        "SDNEntry": null,
        "Name": null,
        "Street": null,
        "City": null,
        "Country": null,
        "DuplicateID": null,
        "RecordDate": null,
        "Memo": null,
        "DPL": null,
        "SDNType": null,
        "Program": null,
        "PostalCode": null,
        "EffectiveDate": null,
        "ExpirationDate": null,
        "Title": null
      }
    ]
  }
}