Category links

API Links

External Parties

To perform certain functions, the CoreCard API system interacts with third-party service providers, referred to as external parties, on a need basis. For example, when a card account is onboarded, you can enable OFAC (Office of Foreign Asset Control) verification, and a customer's credit bureau information to evaluate their creditworthiness (e.g., FICO score, revolving account, mortgage account). When an account is verified, each service provider returns a score or a result code that the CoreCard system can use to decide whether or not a customer is legally eligible to be a cardholder. 

SVG Image

Get OFAC Investigation Report

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetOFACInvestigationReport

POST /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 detail
Fields Description

Source

string

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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

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

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 detail
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 

{
  "application/json": {
    "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"
    }
  }
}

Get Credit Bureau Information

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetCreditBureauInformation

POST /api/CoreCredit/AccountManagement/GetCreditBureauInformation

Use this API to fetch the Credit Bureau Information for an account's  primary applicant or co-applicant (if applicable). The API returns details such as FICO score, debt-to-income ratio, income, rental income, total revolving balance, total mortgage trades, and other factors affecting the credit bureau score.

Request fields detail
Fields Description

Source

string

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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

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

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

Mandatory

Card Holder's Account number. Valid Values: 0-9 Format: XXXXXXXXXXXXXXXX Example: 8000000000000037

Allowable Values:

19
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,
  "AccountNumber": "8000000000000011"
}
Response fields detail
Fields Description

ApplicantInformation

array

All Credit Bureau Info for Applicant will be displayed under this section

CoApplicantInformation

array

All Credit Bureau Info for CoApplicant will be displayed under this section

Sample response body 

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "ApplicantInformation": [
        {
          "FICO": 850,
          "Income": 99000.0,
          "TotalRevolvingBalance": 571.0,
          "RentAmount": 0.0,
          "DebtToIncomeRatio": 0.18,
          "MaximumCreditLimit": 25000.0,
          "Factor1": null,
          "Factor2": null,
          "Factor3": null,
          "Factor4": null,
          "Factor5": "Too many inquiries within the past 12 months",
          "TotalMortgageTrades": 0
        }
      ],
      "CoApplicantInformation": [
        {
          "FICO": 850,
          "Income": 99000.0,
          "TotalRevolvingBalance": 571.0,
          "RentAmount": 0.0,
          "DebtToIncomeRatio": 0.18,
          "MaximumCreditLimit": 25000.0,
          "Factor1": null,
          "Factor2": null,
          "Factor3": null,
          "Factor4": null,
          "Factor5": "Too many inquiries within the past 12 months",
          "TotalMortgageTrades": 0
        }
      ]
    }
  }
}

Get IST WATCH Score

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetISTWATCHScore

POST /api/CoreCredit/AccountManagement/GetISTWATCHScore

IST Watch is an OFAC screening method. The Office of Foreign Asset Control (OFAC)  department of the U.S. Treasury enforces economic and trade sanctions against countries and groups of individuals involved in terrorism, narcotics, and other disreputable activities. In this API, cardholder details such as name and address are verified against the OFAC database. If a match is found, a score is returned based on the number of matching fields. The decision is then taken based on the score.

Request fields detail
Fields Description

Source

string

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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

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

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

SysOrgId

integer

Mandatory

Used for authentication and issued by Core Card. This is a static value to represent institution.

FirstName

string

Optional

First name of individual for query

MiddleName

string

Optional

Middle name of individual for query

LastName

string

Optional

Last name of individual for query

StreetAddress

string

Optional

Street address of individual for query

City

string

Optional

City of individual for query

State

string

Optional

State Name of individual for query

Country

string

Optional

Country Name of individual for query

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,
  "SysOrgId": 6,
  "FirstName": "John"
}
Response fields detail
Fields Description

SysOrgId

integer

Used for authentication and issued by Core Card. This is a static value to represent institution.

FirstName

string

First name of individual for query

MiddleName

string

Middle name of individual for query

LastName

string

Last name of individual for query

StreetAddress

string

Street address of individual for query

City

string

City of individual for query

State

string

State Name of individual for query

Country

string

Country Name of individual for query

ResponseID

string

Unique response identifier

MatchingRecords

array

Array to hold matching SDN records (if any)

Sample response body 

{
  "application/json": {
    "Message": "OK",
    "Status": true,
    "ErrorCode": "ERR01528",
    "ResponseData": {
      "SysOrgId": 7,
      "FirstName": "Osama",
      "MiddleName": "",
      "LastName": "",
      "StreetAddress": "",
      "State": "",
      "Country": "",
      "ResponseID": "56784587",
      "MatchingRecords": [
        {
          "ISTWatchName": "OSAMA, Abu",
          "ISTWatchID": 11697,
          "ISTWatchStreet": "",
          "ISTWatchCity": "",
          "ISTWatchState": "",
          "ISTWatchCountry": "",
          "ISTWatchDuplicateID": 12411,
          "ISTWatchDate": "01/19/2010",
          "ISTWatchPhoneNumber": "",
          "ISTWatchMemo": "DOB 12 Sep 1973; nationality Saudi Arabia; a.k.a. ABU-SAYYAF ; a.k.a. SALAH ; a.k.a.AZIBK, Nut Al-Din Afghani a.k.a. SUL",
          "ISTWatchBALKANS": "False",
          "ISTWatchBPI_PA": "False",
          "ISTWatchCUBA": "False",
          "ISTWatchDPL": "False",
          "ISTWatchFRYM": "False",
          "ISTWatchFTO": "False",
          "ISTWatchIRAN": "False",
          "ISTWatchIRAQ": "False",
          "ISTWatchLIBYA": "False",
          "ISTWatchNKOREA": "False",
          "ISTWatchSDNT": "False",
          "ISTWatchSDNTK": "False",
          "ISTWatchSDGT": "True",
          "ISTWatchSDT": "False",
          "ISTWatchSUDAN": "False",
          "ISTWatchTALIBAN": "False",
          "ISTWatchUNITA": "False",
          "ISTWatchSDN_Type": "individual",
          "ISTWatchProgram": "SDGT",
          "ISTWatchTitle": "",
          "ISTWatchCall_Sign": "",
          "ISTWatchVess_Type": "",
          "ISTWatchTonnage": "",
          "ISTWatchGRT": "",
          "ISTWatchVess_flag": "",
          "ISTWatchVess_Owner": "",
          "ISTWatchAdd_Num": 17649,
          "ISTWatchAdd_remarks": "",
          "ISTWatchPostal_Code": "",
          "ISTWatchEffective_Date": "",
          "ISTWatchExpiration_Date": "",
          "ISTWatchStandard_Order": "",
          "ISTWatchNameSearch_Key": "OSNAAAAAAA",
          "ISTWATCHScore": 91.0
        }
      ]
    }
  }
}

Update Credit Bureau Reporting

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/UpdateCreditBureauReporting

POST /api/CoreCredit/AccountManagement/UpdateCreditBureauReporting

Use this API to update the information on a card account which is used for credit bureau reporting like ECOACodes, CBRIndicator, CBRDate, Bankruptcy Notification Date etc.

Request fields detail
Fields Description

Source

string

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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

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

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:XXXXXXXXXXXX Example:123654789632 Condition:At least one of AdminNumber/AccountNumber/AccountID is required.

Allowable Values:

19

AdminNumber

int64

Conditional

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

ApplicantType

integer

Optional

Selects the type of Applicants. Valid Values: 1,2,3,4 Example: 1 = Applicant, 2 = Co-Applicant , 3 = Cosigner , 4 = Secondary Card

CBRIndicator

integer

Optional

Indicates the CBR value. Valid Values: 0-9 Example: 0 = No, 1 = Yes, 2 = Do Not Send, 3 = Do Not Send - Manual Override etc.

CBRDate

datetime

Mandatory

Indicates the Credit Bureau Reporting date. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

SpecialCommentsOverrideValue

string

Optional

Displays the special comments. Valid Values: a-z Example: A = Account acquired by FDIC/NCUA. AB = Debt being paid through insurance.

Allowable Values:

5

ComplianceConditionCodeOverrideValue

string

Optional

Displays the Compliance code. Valid Values: a-z Example: NO = None XA = Account closed at consumer's request

Allowable Values:

5

AuthorizedUserCBRIndicator

integer

Optional

Indicates the authorised user. Valid Values: 0 = No, 1 = Yes Example: 0

ClientID

integer

Optional

Client ID of the client. Valid Values: 0-9 Example: 7815

ConsumerInformationIndicator

string

Optional

Bankruptcy Codes for the consumer.

Allowable Values:

10

BankruptcyNotificationDate

datetime

Optional

Indicates Bankrupt notification date. Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

ECOACodes

string

Optional

The ECOA Code defines the relationship of the consumer to the account in compliance with the Equal Credit Opportunity Act. Valid Values: 1 = Individual 2 = Joint Contractual Liability 3 = Authorized user 5 = Co-maker or Guarantor 7 = Maker T = Terminated X = Deceased W = Business/Commercial Z = Delete Consumer

Allowable Values:

1

AccountID

integer

Conditional

Account ID represents Unique Identity of Account (CoreCard Bsegment Entity, i.e., the Account ID of program card account). Valid Values: 0-9 Format:XXXXXX Example:123654 Condition:At least one of AdminNumber/AccountNumber/AccountID is required.

SpecialCommentsDerivedValue

string

Optional

Displayes the derived value of Compliance Condition Code. Valid Values: 0-9 a-z Example:XA

Allowable Values:

25

ComplianceConditionCodeDerivedValue

string

Optional

Displayes the derived value of Compliance Condition Code. Valid Values: 0 - 9 a-z Example:XA

Allowable Values:

25

SpecialCommentsLastReportedValue

string

Optional

Displayes the Last Reported value of special comment. Valid Values: 0 - 9 a-z Example:AH

Allowable Values:

25

ComplianceLastReportedValue

string

Optional

Displayes the Last reported Value of Compliance Condition Code. Valid Values: 0 - 9 a-z Example:AH

Allowable Values:

25

FCRA1stDateOfDelinquency

string

Optional

1st date of delinquency (Fair Credit Reporting Act) Format: MM/DD/YYYY HH:MM:SS Example: 01/01/2020 11:05:05

Allowable Values:

25

BankruptcyFiledDate

datetime

Conditional

Indicates the Bankruptcy File Date. Format: MM/DD/YYYY Example: 01/01/2020 Condition: Selection of CII values as per Table 1 and field CBR Report Type (CI).

Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountID": null,
  "AccountNumber": "8000000000000011",
  "AdminNumber": null,
  "ApplicantType": 0,
  "ECOACodes": "",
  "CBRIndicator": 0,
  "CBRDate": "03/15/2020 00:00:00",
  "SpecialCommentsOverrideValue": null,
  "ComplianceConditionCodeOverrideValue": null,
  "SpecialCommentsDerivedValue": null,
  "ComplianceConditionCodeDerivedValue": null,
  "SpecialCommentsLastReportedValue": null,
  "ComplianceLastReportedValue": null,
  "AuthorizedUserCBRIndicator": null,
  "ClientID": 4258,
  "ConsumerInformationIndicator": null,
  "BankruptcyNotificationDate": null,
  "FCRA1stDateOfDelinquency": null,
  "BankruptcyFiledDate": null
}
Response fields detail
Fields Description

Sample response body 

{
  "application/json": {
    "Message": "Updated Successfully.",
    "Status": true,
    "ErrorCode": "ERR01045",
    "ResponseData": null
  }
}

Manage Bank Account

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/BankAccountCRUD

POST /api/CoreCredit/AccountManagement/BankAccountCRUD

Use this API to add, update, or delete a bank account mapped to an account by entering the card number, admin number, or account number, as well as the type of request.

Note

A. If the bank account has active schedules, then the user is not allowed to update/delete it.
B. If Bank Account's Status is 1 (PreNote Sent), then the user is not allowed to delete it.
C. If Bank Account's Status is 1 (PreNote Sent), 2(Validated), 3(Validation Rejected), 4(Deleted), then the user is not allowed to update it.

Request fields detail
Fields Description

Source

string

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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 ---- es: means Spanish

Allowable Values:

10

ExternalIP

string

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

Version of the API to be invoked. Example: 2.0 API Version Current Version 2.0

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

Allowable Values:

19

AdminNumber

int64

Conditional

Details can be obtained by admin number (Embossing Acctid) Valid Values:0-9 Format:XXXXX Example:12345

CardNumber

string

Conditional

Card Number of account holder Valid Values:0-9 Format:XXXXXXXXXXXXXXXX Example:1236547896541236

Allowable Values:

19

BankAccountType

integer

Mandatory

Type of Bank account added by customer for card payment,0=checking and 1=saving Valid Values:0,1 Format:X Example:0,1

BankAccountNumber

string

Conditional

Bank Account Number Valid Values:0000000001234567891 Format:XXXXXXXXXXXXXXXXXXX Example:0000000001234567891

Allowable Values:

19

BankRoutingNumber

string

Conditional

Bank Rrouting number identifies the location of the bank's branch Valid Values:111000038 Format:XXXXXXXXX Example: 111000038

Allowable Values:

9

BankName

string

Conditional

Name of the Bank Valid Values:JPMorgan Chase Format:XXXXXXXXXX Example:JPMorgan Chase

Allowable Values:

100

CreditBalanceRefund

integer

Mandatory

Falg to describe credit balance refund,Only and Only one Bank Account can be 1 (Yes) of an Account Valid Values:Yes/No Example: Yes/No

RequestType

string

Mandatory

Request Type defines the action to be perform in Bank Account. Possible value would be (0 : Add, 1 : Delete, 2 : Update) Valid Values:0 Add 1 Delete 2 Update Format:X

MethodName

int64

Conditional

Method Name uniquely identifies bank accounts in Core card system. Whenever user adds any bank account. This is required If User wants to send transaction in ACH. Valid Values:0-9 Format:XXXX Example:4092

Sample request body 
{
  "Source": "Web",
  "IPAddress": "10.120.0.0",
  "DateFormat": null,
  "CurrencyCode": null,
  "CurrencySymbolType": null,
  "Language": null,
  "ExternalIP": "10.120.0.0",
  "SessionID": null,
  "APIVersion": "2.0",
  "CallerID": null,
  "CalledID": null,
  "RequestTime": null,
  "AccountNumber": "5000000000012186",
  "AdminNumber": 95957,
  "CardNumber": null,
  "BankAccountType": 0,
  "BankAccountNumber": "2011474202",
  "BankRoutingNumber": "022309611",
  "BankName": "testbank",
  "CreditBalanceRefund": 1,
  "RequestType": "0",
  "MethodName": null,
  "ApplicantType": null
}
Response fields detail
Fields Description

Sample response body 

{
  "200": {
    "description": "Success",
    "schema": {
      "$ref": "#/definitions/BankAccountCRUDResponseModelApiResult"
    },
    "examples": {
      "application/json": {
        "Message": "Bank Account Management Added",
        "Status": true,
        "ErrorCode": "ERR01004",
        "ResponseData": {}
      }
    }
  },
  "ERR04041": {
    "description": "Either Account Number or Admin Number is Required."
  },
  "ERR01004": {
    "description": "Bank Account Management Added."
  },
  "ERR01005": {
    "description": "Bank Account Management Deleted."
  },
  "ERR04014": {
    "description": "Bank Account Management Updated."
  },
  "ERR03043": {
    "description": "Invalid Account identifier input parameter(s)."
  },
  "ERR03124": {
    "description": "Invalid Request Type."
  },
  "ERR02141": {
    "description": "Request Type can not be blank."
  },
  "ERR03011": {
    "description": "Bank Route should be null while deleting Bank Account information."
  },
  "ERR02109": {
    "description": "Method Name can not be blank."
  },
  "ERR03010": {
    "description": "Bank Route Number should be numeric."
  },
  "ERR03167": {
    "description": "Please enter 9 digit Bank Route Number."
  },
  "ERR03052": {
    "description": "Invalid Bank Route Number."
  },
  "ERR02020": {
    "description": "Bank route number can not be left blank."
  },
  "ERR03007": {
    "description": "Bank Account Number should be blank while deleting Bank Account information."
  },
  "ERR03009": {
    "description": "Bank Account Number should be numeric."
  },
  "ERR03050": {
    "description": "Invalid Bank Account Number."
  },
  "ERR03006": {
    "description": "Bank Account Number and Confirm Bank Account Number should be same."
  },
  "ERR03008": {
    "description": "Bank Account Number should be blank while updating Bank Account information."
  },
  "ERR02012": {
    "description": "Bank Account Number can not be left blank."
  },
  "ERR02110": {
    "description": "Method type can not be left blank."
  },
  "ERR02052": {
    "description": "Confirm Bank Account Number can not be left blank."
  },
  "ERR03155": {
    "description": "Method Type should be blank while deleting Bank Account information."
  },
  "ERR03107": {
    "description": "Invalid Method Type."
  },
  "ERR01054": {
    "description": "This Bank Account Number is already added."
  },
  "ERR04116": {
    "description": "This Bank Account Information does not exist."
  },
  "ERR02025": {
    "description": "Can not delete/update Bank Account Information, as it has active schedule."
  },
  "ERR02015": {
    "description": "Bank name can not be left blank."
  },
  "ERR02011": {
    "description": "Bank Account Information can not be updated, if Status is Validation Rejected(3)."
  },
  "ERR02059": {
    "description": "Credit Balance Refund can not be left Blank."
  },
  "ERR04032": {
    "description": "Credit Balance Refund can only be 0 = No/1 = Yes."
  },
  "ERR04074": {
    "description": "Only one Bank Account can have Credit Balance Refund 1(Yes)."
  },
  "ERR03160": {
    "description": "Only Bank Name and Credit Balance Refund can be updated, if Status is Pre Note Sent(1) or Validated(2)."
  },
  "ERR01053": {
    "description": "This Bank Account Information can not be deleted, as prenote has sent to ACH."
  },
  "ERR04085": {
    "description": "Provide at least one parameter for update."
  },
  "ERR03004": {
    "description": "At least one Account identifier input parameter should be passed."
  },
  "ERR04049": {
    "description": "Error encountered: Please Try Again Later."
  },
  "ERR03001": {
    "description": "Admin Number should be numeric."
  },
  "ERR03068": {
    "description": "Program Restriction :Invalid Service User or Account Identifier."
  }
}

Get OFAC Results

Action: POST

Endpoint: /api/CoreCredit/AccountManagement/GetOFACResults

POST /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 detail
Fields Description

Source

string

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

Place Holder for Future Use. Currency Code Ex. 840 = US Doller.

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

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

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

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": 0
}
Response fields detail
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: 1 = Applicant 2 = Co-Applicant 3 = Cosigner 4 = Secondary Card Format:XXXXX Example: 1

Sample response body 

{
  "application/json": {
    "Message": "Success",
    "Status": true,
    "ErrorCode": "Err00017",
    "ResponseData": {
      "LastIndividualOFACCheckDate": null,
      "LastBulkOFACCheckDate": null,
      "OFACScore": 90,
      "SDNEntry1": 80,
      "SDNEntry2": 80,
      "SDNEntry3": 80,
      "SDNEntry4": 80,
      "SDNEntry5": null,
      "ApplicantType": null
    }
  }
}