Get Credit Bureau Information
Action: POST
Endpoint: /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 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 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 details
| 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
{
"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
}
]
}
}