Equifax Bureau with PDF
Introduction:
The Equifax Bureau Report API enables patrons to retrieve credit information from Equifax for a given individual using specified parameters such as phone number, PAN (Permanent Account Number), first name, and last name. This API is tailored to deliver comprehensive credit reports from Equifax, facilitating the assessment of an individual's creditworthiness.
Key Features
- Credit Information Retrieval: Patrons can access detailed credit reports from Equifax using parameters like phone number, PAN, first name, and last name.
Benefits
- Assessment of Creditworthiness: The API assists in evaluating an individual's creditworthiness by providing detailed credit reports from Equifax.
Conclusion
In summary, the Equifax Bureau Report API offers a convenient solution for fetching credit information from Equifax, aiding in the assessment of individuals' creditworthiness.
Sample Curl:
curl --location 'https://api.signzy.app/api/v3/bureau/equifax-bureau-report' \
--header 'Content-Type: application/json' \
--header 'Authorization: <authtoken>' \
--data '{
"phoneNumber": "1234567890",
"name": "JOHN DOE",
"dateOfBirth": "1988-02-16",
"pan": "ABCDE1111B",
"address": "******",
"state": "KA",
"pincode": "******",
"consent": {
"consentFlag": true,
"consentTimestamp": 1728631641845,
"consentIpAddress": "************",
"consentMessageId": "CM_1"
}
}'Input Parameters:
Parameter | Type | Mandatory/Optional | Description |
|---|---|---|---|
phoneNumber | Number | Mandatory | The phone number of the individual for whom the Equifax report is requested. |
pan | String | Mandatory | The PAN (Permanent Account Number) of the individual. |
name | String | Mandatory | The name of the individual. |
dateOfBirth | String | Mandatory | Date of Birth of the user yyyy-mm-dd |
address | String | Mandatory | Address of the user |
state | String | Optional | State of the user |
pincode | String | Mandatory | pincode of the user |
consent | Object | Optional | Consent provided by user |
consent[consentFlag] | Boolean | Mandatory | A boolean flag representing if consent is present or not. |
consent[consentTimestamp] | Number | Mandatory | Timestamp of consent provided by user in seconds or milliseconds. |
consent[consentIpAddress] | String | Mandatory | Ip address of the user's device giving the consent. |
consent[consentMessageId] | String | Mandatory | It is a mapping of consent messageId to consent message |
Consent Message ID Mapping:
ID | Message |
|---|---|
CM_1 | I hereby consent that I am sharing my consent to signzy to collect my bureau report |
State Mapping:
Value | Description | Pincode Range (First 3 Numbers) |
|---|---|---|
AN | Andaman & Nicobar Islands | 744 |
AP | Andhra Pradesh | 500 - 535 |
AR | Arunachal Pradesh | 790 - 792 |
AS | Assam | 781 - 788 |
BR | Bihar | 800 - 855 |
CG | Chhattisgarh | 490 - 497 |
CH | Chandigarh | 160 |
DD | Daman & Diu | 362, 396 |
DL | Delhi | 110 |
DN | Dadra & Nagar Haveli | 396 |
GA | Goa | 403 |
GJ | Gujarat | 360 - 396 |
HP | Himachal Pradesh | 171 - 177 |
HR | Haryana | 121 - 136 |
JH | Jharkhand | 813 - 835 |
JK | Jammu & Kashmir | 180 - 194 |
KA | Karnataka | 560 - 591 |
KL | Kerala | 670 - 695 |
LD | Lakshadweep | 682 |
MH | Maharashtra | 400 - 445 |
ML | Meghalaya | 793 - 794 |
MN | Manipur | 795 |
MP | Madhya Pradesh | 450 - 488 |
MZ | Mizoram | 796 |
NL | Nagaland | 797 - 798 |
OR | Odisha | 751 - 770 |
PB | Punjab | 140 - 160 |
PY | Pondicherry/Puducherry | 533, 605, 607, 609 |
RJ | Rajasthan | 301 - 345 |
SK | Sikkim | 737 |
TG | Telangana | 500 - 509 |
TN | Tamil Nadu | 600 - 643 |
TR | Tripura | 799 |
UL | Uttarakhand | 244 - 263 |
UP | Uttar Pradesh | 201 - 285 |
WB | West Bengal | 700 - 743 |
Sample Response:
{
"statusCode": 200,
"message": "Success",
"data": {
"equifaxReport": {
"IDAndContactInfo": {
"PersonalInfo": {
"Name": {
"FullName": "SATHISH KUMAR ",
"FirstName": "SATHISH ",
"LastName": "KUMAR "
},
" AliasName": {},
"DateOfBirth": "1986-06-03",
"Gender": "Male",
"Age": {
"Age": "38"
},
"PlaceOfBirthInfo": {},
"TotalIncome": "420000000"
},
"IdentityInfo": {
"PANId": [
{
"seq": "1",
"ReportedDate": "2024-05-31",
"IdNumber": "BUXPS2681D"
}
],
"VoterID": [
{
"seq": "1",
"ReportedDate": "2024-05-31",
"IdNumber": "ROG0032698"
}
],
"NationalIDCard": [
{
"seq": "1",
"ReportedDate": "2024-05-31",
"IdNumber": "XXXXXXXXXXXX"
}
]
},
"AddressInfo": [
{
"Seq": "1",
"ReportedDate": "2024-05-31",
"Address": "223 N A THEVAR STREET OLYMBUS COIMBATORE SOUTH COIMBATORE SOUTH DISTRICT",
"State": "TN",
"Postal": "641045",
"Type": "Owns"
},
{
"Seq": "2",
"ReportedDate": "2024-04-25",
"Address": "223 NACHIANNAN ANGANNAN STREET RAMANATHAPURAM COIMBATORE",
"State": "TN",
"Postal": "641045",
"Type": "Rents,Primary"
},
{
"Seq": "3",
"ReportedDate": "2023-09-01",
"Address": "NO-223 NACHIANNAN ANGANNAN STREET RAMANATHAPURAM TAMILNADU 641045",
"State": "TN",
"Postal": "641045",
"Type": "Primary"
},
{
"Seq": "4",
"ReportedDate": "2016-09-16",
"Address": "NO-223 NACHIANNAN ANGANNAN STREET RAMANA THAPURAM RAMANATHAPURAM COIMBATORE",
"State": "TN",
"Postal": "641045"
},
{
"Seq": "5",
"ReportedDate": "2016-09-16",
"Address": "KIKANI EXPORT PVT LTD 104 WEST PERIASAMA Y ROAD R S PRUAM COIMBATORE",
"State": "TN",
"Postal": "641045"
}
],
"PhoneInfo": [
{
"seq": "1",
"typeCode": "H",
"ReportedDate": "2024-05-31",
"Number": "8122244473"
},
{
"seq": "2",
"typeCode": "H",
"ReportedDate": "2020-12-31",
"Number": "9787772762"
},
{
"seq": "3",
"typeCode": "M",
"ReportedDate": "2023-09-01",
"Number": "9842372492"
},
{
"seq": "4",
"typeCode": "M",
"ReportedDate": "2024-05-31",
"Number": "8122244473"
},
{
"seq": "5",
"typeCode": "T",
"ReportedDate": "2019-08-31",
"Number": "8122244473"
},
{
"seq": "6",
"typeCode": "T",
"ReportedDate": "2017-01-31",
"Number": "9047052224"
}
],
"EmailAddressInfo": [
{
"seq": "1",
"ReportedDate": "2024-04-25",
"EmailAddress": "[email protected]"
}
]
},
"RetailAccountDetails": [
{
"seq": "1",
"AccountNumber": "XXXXXXXXXX9119",
"Institution": "Bajaj Finance Limited",
"AccountType": "Consumer Loan",
"OwnershipType": "Individual",
"Balance": "11980",
"PastDueAmount": "0",
"Open": "Yes",
"SanctionAmount": "62895",
"LastPaymentDate": "2024-06-10",
"DateReported": "2024-07-31",
"DateOpened": "2023-04-11",
"RepaymentTenure": "21",
"InstallmentAmount": "2995",
"TermFrequency": "Monthly",
"AccountStatus": "Current Account",
"source": "INDIVIDUAL",
"History48Months": [
{
"key": "07-24",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "06-24",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "05-24",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "04-24",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "03-24",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "02-24",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "01-24",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "12-23",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "11-23",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "10-23",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "09-23",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "08-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "07-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "06-23",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "05-23",
"PaymentStatus": "NEW",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
}
]
},
{
"seq": "2",
"AccountNumber": "XXXXXXXXXXX0886",
"Institution": "Indian Overseas Bank",
"AccountType": "Business Loan - Priority Sector- Small Business",
"OwnershipType": "Individual",
"Balance": "63500",
"PastDueAmount": "0",
"Open": "Yes",
"SanctionAmount": "68000",
"LastPaymentDate": "2024-07-19",
"DateReported": "2024-07-31",
"DateOpened": "2024-05-30",
"InterestRate": "8.85",
"TermFrequency": "Bullet Payment",
"CollateralValue": "98000",
"AccountStatus": "Current Account",
"AssetClassification": "Standard",
"source": "INDIVIDUAL",
"History48Months": [
{
"key": "07-24",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "06-24",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "05-24",
"PaymentStatus": "NEW",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
}
]
},
{
"seq": "3",
"AccountNumber": "XXXXXXXXXXXX5005",
"Institution": "Union Bank of India",
"AccountType": "Credit Card",
"OwnershipType": "Individual",
"Balance": "15269",
"PastDueAmount": "0",
"LastPayment": "2000",
"Open": "No",
"HighCredit": "8000",
"LastPaymentDate": "2024-07-08",
"DateReported": "2024-07-25",
"DateOpened": "2017-03-22",
"DateClosed": "2017-05-03",
"InterestRate": "2.5",
"TermFrequency": "Monthly",
"CreditLimit": "15000",
"AccountStatus": "Current Account",
"AssetClassification": "Standard",
"source": "INDIVIDUAL",
"History48Months": [
{
"key": "07-24",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "06-24",
"PaymentStatus": "30+",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "05-24",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "04-24",
"PaymentStatus": "60+",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "03-24",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "02-24",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "01-24",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "12-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "11-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "10-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "09-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "08-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "07-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "06-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "05-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "04-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "03-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "02-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "01-23",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "12-22",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "11-22",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "10-22",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "09-22",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "08-22",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "07-22",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "06-22",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "05-22",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "04-22",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "03-22",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "02-22",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "01-22",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "12-21",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "11-21",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "10-21",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "09-21",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "08-21",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "07-21",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "06-21",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "05-21",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "04-21",
"PaymentStatus": "30+",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "03-21",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "02-21",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "01-21",
"PaymentStatus": "*",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "12-20",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "11-20",
"PaymentStatus": "30+",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "10-20",
"PaymentStatus": "30+",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "09-20",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
},
{
"key": "08-20",
"PaymentStatus": "60+",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "STD"
}
]
},
{
"seq": "4",
"AccountNumber": "XXXXXXXXXX3883",
"Institution": "Bajaj Finance Limited",
"AccountType": "Consumer Loan",
"OwnershipType": "Individual",
"Balance": "1503",
"PastDueAmount": "0",
"Open": "Yes",
"SanctionAmount": "2711",
"DateReported": "2015-10-31",
"DateOpened": "2015-05-26",
"AccountStatus": "Current Account",
"source": "INDIVIDUAL",
"History48Months": [
{
"key": "10-15",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "09-15",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "08-15",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "07-15",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "06-15",
"PaymentStatus": "000",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
},
{
"key": "05-15",
"PaymentStatus": "NEW",
"SuitFiledStatus": "*",
"AssetClassificationStatus": "*"
}
]
}
],
"RetailAccountsSummary": {
"NoOfAccounts": "30",
"NoOfActiveAccounts": "3",
"NoOfWriteOffs": "0",
"TotalPastDue": "1600.00",
"MostSevereStatusWithIn24Months": "Set",
"SingleHighestCredit": "0.00",
"SingleHighestSanctionAmount": "68000.00",
"TotalHighCredit": "0.00",
"AverageOpenBalance": "25661.00",
"SingleHighestBalance": "63500.00",
"NoOfPastDueAccounts": "3",
"NoOfZeroBalanceAccounts": "0",
"RecentAccount": "Business Loan - Priority Sector- Small Business on 30-05-2024",
"OldestAccount": "Consumer Loan on 06-05-2014",
"TotalBalanceAmount": "76983.00",
"TotalSanctionAmount": "133606.00",
"TotalCreditLimit": "0.0",
"TotalMonthlyPaymentAmount": "2995.00"
},
"ScoreDetails": [
{
"Type": "ERS",
"Version": "4.0",
"Name": "ERS4.0",
"Value": "639",
"ScoringElements": [
{
"type": "RES",
"seq": "1",
"code": "400",
"Description": "Occurances of default account"
},
{
"type": "RES",
"seq": "2",
"code": "401",
"Description": "Vintage in Bureau"
},
{
"type": "RES",
"seq": "3",
"code": "403",
"Description": "Delinquency presence"
}
]
}
],
"Enquiries": [
{
"seq": "1",
"Institution": "Fincare Small Finance Bank Limited",
"Date": "2024-06-06",
"Time": "15:24",
"RequestPurpose": "00"
},
{
"seq": "2",
"Institution": "Fincare Small Finance Bank Limited",
"Date": "2024-06-06",
"Time": "14:17",
"RequestPurpose": "00"
},
{
"seq": "3",
"Institution": "Fincare Small Finance Bank Limited",
"Date": "2024-06-06",
"Time": "11:45",
"RequestPurpose": "00"
},
{
"seq": "4",
"Institution": "Fincare Small Finance Bank Limited",
"Date": "2024-05-23",
"Time": "17:09",
"RequestPurpose": "00"
},
{
"seq": "5",
"Institution": "Fincare Small Finance Bank Limited",
"Date": "2024-05-23",
"Time": "11:09",
"RequestPurpose": "00"
}
],
"EnquirySummary": {
"Purpose": "ALL",
"Total": "689",
"Past30Days": "0",
"Past12Months": "189",
"Past24Months": "390",
"Recent": "2024-07-01"
},
"OtherKeyInd": {
"AgeOfOldestTrade": "124",
"NumberOfOpenTrades": "2",
"AllLinesEVERWritten": "0.00",
"AllLinesEVERWrittenIn9Months": "0",
"AllLinesEVERWrittenIn6Months": "0"
},
"RecentActivities": {
"AccountsDeliquent": "3",
"AccountsOpened": "0",
"TotalInquiries": "4",
"AccountsUpdated": "5"
}
},
"statusCode": 200,
"pdfReport": "https://staging-persist.signzy.tech/api/files/5135689/download/8bb9267ee0c641109b4652c38a4989c069db8d151a784013b74d07628393d00c.pdf"
},
"derivedFields": {
"lastPaymentDate": "2024-07-19",
"listOfInstitutions": [
{
"institutionName": "Bajaj Finance Limited",
"noOfTotalAccounts": 7,
"noOfOpenAccounts": 2,
"longestDurationOfClosedAccounts": 615
},
{
"institutionName": "Indian Overseas Bank",
"noOfTotalAccounts": 12,
"noOfOpenAccounts": 1,
"longestDurationOfClosedAccounts": 366
},
{
"institutionName": "Union Bank of India",
"noOfTotalAccounts": 3,
"noOfOpenAccounts": 1,
"longestDurationOfClosedAccounts": 2502
}
]
}
}Output Parameters:
Parameter | Data Type | Description |
|---|---|---|
statusCode | Integer | Represents the status code of the response. |
message | String | Describe the response's status, and whether it was successful or encountered an error. |
data | Object | Contains the main data of the response. |
data[equifaxReport] | Object | Contains detailed information from the Equifax report. |
data[equifaxReport][IDAndContactInfo] | Object | Contains personal and contact information. |
data[equifaxReport][RetailAccountDetails] | Array | Contains details about retail accounts. |
data[equifaxReport][RetailAccountsSummary] | Object | Provides a summary of retail accounts. |
data[equifaxReport][ScoreDetails] | Array | Contains information about the individual's credit score. |
data[equifaxReport][Enquiries] | Array | Lists of inquiries were made regarding the individual's credit report. |
data[equifaxReport][EnquirySummary] | Object | Summarizes inquiries made, including purpose and total inquiries. |
data[equifaxReport][OtherKeyInd] | Object | Includes key indicators like age of oldest trade, number of open trades, etc. |
data[equifaxReport][RecentActivities] | Object | Summarizes recent activities related to the individual's accounts. |
data[equifaxReport][statusCode] | integer | Represents the status code specific to the Equifax report data. |
data[equifaxReport][pdfReport] | String | PDF report download url. |
derivedFields | Object | |
derivedFields.lastPaymentDate | String | Most recent value in the key LastPaymentDate among all objects in equifaxReport.retailAccountDetails |
derivedFields.listOfInstitutions | Array | List of unique “Institutions” from all objects in equifaxReport.retailAccountDetails |
derivedFields.listOfInstitutions[n].institutionName | String | Name of the institution |
derivedFields.listOfInstitutions[n].noOfTotalAccounts | String | Count where Institution = nameOfInstitution accountStatus = “Current Account” in equifaxReport.retailAccountDetails |
derivedFields.listOfInstitutions[n].noOfOpenAccounts | String | Count where Institution = nameOfInstitution in equifaxReport.retailAccountDetails |
derivedFields.listOfInstitutions[n].longestDurationOfClosedAccounts | String | Longest no. of days between dateClosed - dateOpened Where Institution = nameOfInstitution accountStatus = “Closed Account” in equifaxReport.retailAccountDetails |
Status Codes:
CODE | MESSAGE |
|---|---|
200 | Request successful |
400 | Validation Error |
409 | Upstream is down |
500 | Server Side Error |
401 | Unauthroised Access |
429 | Too Many Requests |
499 | Gatway Timeout |