> ## Documentation Index > Fetch the complete documentation index at: https://docs.dojah.io/llms.txt > Use this file to discover all available pages before exploring further. # Credit Summary > The Credit Summary API provides a comprehensive summary of an individual's credit history, linked to their Bank Verification Number (BVN). This API is designed to give financial institutions, lenders, and credit agencies a quick and accurate overview of a user's creditworthiness, including outstanding loans, repayment history, and overall credit behavior. Use with the BVN Number ### Request ```http [GET] theme={null} {{baseUrl}}/api/v1/credit_bureau ``` ### Header | Header | Type | Description | | ------------- | ------ | --------------------------------------------------------------------------------------------------- | | AppId | string | Create an app to get your app ID on dashboard [here](https://app.dojah.io/developers/configuration) | | Authorization | string | Private/secret key. Use `` not `Bearer ` | ### Query parameter | Parameter | Type | Description | Required | | --------- | ------ | ---------------------- | -------- | | bvn | string | BVN Number of Customer | required | ### Sample response ```json Response theme={null} { "entity": { "address": "ELEGANZA HOUSE,15B JOSEPH WESLEY STR.BROAD STREET 025 NG LAGOS NIGERIA ", "bvn": "1*****78901", "dateOfBirth": "01/01/1904", "email": "", "gender": "Male", "name": "John Doe Anon", "phone": "080123456789", "score": { "bureauStatus": { "crc": "success", "creditRegistry": "success", "firstCentral": "success" }, "creditEnquiries": [ { "source": "CREDIT_REGISTRY", "value": [ { "contactPhone": "234 (1) 2798800", "date": "2022-11-13T00:00:00", "loanProvider": "Suretree Systems Limited", "reason": "N/A" } ] } ], "creditEnquiriesSummary": [ { "source": "CREDIT_REGISTRY", "value": { "Last12MonthCount": "38", "Last36MonthCount": "101", "Last3MonthCount": "4" } } ], "creditors": [ { "source": "CREDIT_REGISTRY", "value": [ { "Address": "Stallion Plaza 36 Marina Lagos Island Lagos", "Name": "Union Bank of Nigeria Plc", "Phone": "0123456789", "Subscriber_ID": "734289734289248261" } ] } ], "highestLoanAmount": [ { "source": "CRC", "value": 5000 } ], "lastReportedDate": [ { "source": "CRC", "value": "13/Nov/2022" } ], "loanHistory": [ { "source": "CRC", "value": [ { "accountNumber": "01234567893", "dateReported": "30-Apr-2019", "installmentAmount": "", "lastPaymentDate": "", "loanAmount": "5000", "loanDuration": null, "loanProvider": "UNION BANK OF NIGERIA PLC", "outstandingBalance": "0", "overdueAmount": "0", "paymentHistory": [], "performanceStatus": "Performing", "status": "Open", "type": "Overdraft" } ] } ], "loanPerformance": [ { "source": "FIRST_CENTRAL", "value": [ { "accountNumber": "12345678928181192", "loanAmount": 250800, "loanCount": 1, "loanProvider": "Union Bank Nigeria Plc Lagos", "noOfNonPerforming": 0, "noOfPerforming": 1, "outstandingBalance": 0, "overdueAmount": 0, "performanceStatus": "Performing", "status": "Closed" } ] } ], "maxNoOfDays": [ { "source": "CRC", "value": null } ], "totalBorrowed": [ { "source": "CRC", "value": 445800 } ], "totalMonthlyInstallment": [ { "source": "CRC", "value": 10000 } ], "totalNoOfActiveLoans": [ { "source": "CRC", "value": 1 } ], "totalNoOfClosedLoans": [ { "source": "CRC", "value": 2 } ], "totalNoOfDelinquentFacilities": [ { "source": "CRC", "value": 0 } ], "totalNoOfInstitutions": [ { "source": "CRC", "value": 1 } ], "totalNoOfLoans": [ { "source": "CRC", "value": 3 } ], "totalNoOfOverdueAccounts": [ { "source": "CRC", "value": 0 } ], "totalNoOfPerformingLoans": [ { "source": "CRC", "value": 3 } ], "totalOutstanding": [ { "source": "CRC", "value": 0 } ], "totalOverdue": [ { "source": "CRC", "value": 0 } ] }, "searchedDate": "2023-12-13T08:42:25.835Z" } } ``` ### Response Fields | Field | Type | Description | | ------------------------------------------------------------- | ------------ | ---------------------------------------------------------------------- | | entity | object | Contains the credit summary response data | | entity.address | string | Registered address of the individual | | entity.bvn | string | The Bank Verification Number | | entity.dateOfBirth | string | Date of birth of the individual (DD/MM/YYYY) | | entity.email | string | Email address of the individual (may be empty) | | entity.gender | string | Gender of the individual | | entity.name | string | Full name of the individual | | entity.phone | string | Phone number associated with the BVN | | entity.score | object | Aggregated credit data from multiple bureaus | | entity.score.bureauStatus | object | Connection status for each credit bureau queried | | entity.score.bureauStatus.crc | string | Status of the CRC bureau query (e.g., `success`) | | entity.score.bureauStatus.creditRegistry | string | Status of the Credit Registry bureau query (e.g., `success`) | | entity.score.bureauStatus.firstCentral | string | Status of the First Central bureau query (e.g., `success`) | | entity.score.creditEnquiries | array | List of credit enquiries made against the individual | | entity.score.creditEnquiries\[].source | string | Credit bureau source (e.g., `CREDIT_REGISTRY`, `CRC`, `FIRST_CENTRAL`) | | entity.score.creditEnquiries\[].value | array | Individual enquiry records from this bureau | | entity.score.creditEnquiries\[].value\[].contactPhone | string | Contact phone of the enquiring institution | | entity.score.creditEnquiries\[].value\[].date | string | Date the credit enquiry was made (ISO 8601) | | entity.score.creditEnquiries\[].value\[].loanProvider | string | Name of the institution that made the enquiry | | entity.score.creditEnquiries\[].value\[].reason | string | Reason for the credit enquiry | | entity.score.creditEnquiriesSummary | array | Summary counts of credit enquiries over time periods | | entity.score.creditEnquiriesSummary\[].source | string | Credit bureau source | | entity.score.creditEnquiriesSummary\[].value | object | Enquiry count breakdown | | entity.score.creditEnquiriesSummary\[].value.Last3MonthCount | string | Number of enquiries in the last 3 months | | entity.score.creditEnquiriesSummary\[].value.Last12MonthCount | string | Number of enquiries in the last 12 months | | entity.score.creditEnquiriesSummary\[].value.Last36MonthCount | string | Number of enquiries in the last 36 months | | entity.score.creditors | array | List of creditors associated with the individual | | entity.score.creditors\[].source | string | Credit bureau source | | entity.score.creditors\[].value | array | Creditor records from this bureau | | entity.score.creditors\[].value\[].Address | string | Address of the creditor institution | | entity.score.creditors\[].value\[].Name | string | Name of the creditor institution | | entity.score.creditors\[].value\[].Phone | string | Contact phone of the creditor | | entity.score.creditors\[].value\[].Subscriber\_ID | string | Unique subscriber identifier of the creditor | | entity.score.highestLoanAmount | array | Highest loan amount recorded per bureau | | entity.score.highestLoanAmount\[].source | string | Credit bureau source | | entity.score.highestLoanAmount\[].value | number | Highest single loan amount | | entity.score.lastReportedDate | array | Date of last report per bureau | | entity.score.lastReportedDate\[].source | string | Credit bureau source | | entity.score.lastReportedDate\[].value | string | Date of the most recent credit report entry (DD/MMM/YYYY) | | entity.score.loanHistory | array | Detailed loan history records per bureau | | entity.score.loanHistory\[].source | string | Credit bureau source | | entity.score.loanHistory\[].value | array | Individual loan records | | entity.score.loanHistory\[].value\[].accountNumber | string | Loan account number | | entity.score.loanHistory\[].value\[].dateReported | string | Date the loan was reported (DD-MMM-YYYY) | | entity.score.loanHistory\[].value\[].installmentAmount | string | Monthly installment amount | | entity.score.loanHistory\[].value\[].lastPaymentDate | string | Date of the last payment made (DD-MMM-YYYY) | | entity.score.loanHistory\[].value\[].loanAmount | string | Original loan amount | | entity.score.loanHistory\[].value\[].loanDuration | string\|null | Duration of the loan | | entity.score.loanHistory\[].value\[].loanProvider | string | Name of the lending institution | | entity.score.loanHistory\[].value\[].outstandingBalance | string | Remaining balance on the loan | | entity.score.loanHistory\[].value\[].overdueAmount | string | Amount currently overdue | | entity.score.loanHistory\[].value\[].paymentHistory | array | Historical payment records for the loan | | entity.score.loanHistory\[].value\[].performanceStatus | string | Loan performance status (e.g., `Performing`, `Non-Performing`) | | entity.score.loanHistory\[].value\[].status | string | Current loan status (e.g., `Open`, `Closed`) | | entity.score.loanHistory\[].value\[].type | string | Type of credit facility (e.g., `Overdraft`, `Term Loan`) | | entity.score.loanPerformance | array | Loan performance summary per bureau | | entity.score.loanPerformance\[].source | string | Credit bureau source | | entity.score.loanPerformance\[].value | array | Loan performance records | | entity.score.loanPerformance\[].value\[].accountNumber | string | Loan account number | | entity.score.loanPerformance\[].value\[].loanAmount | number | Original loan amount | | entity.score.loanPerformance\[].value\[].loanCount | number | Number of loans with this provider | | entity.score.loanPerformance\[].value\[].loanProvider | string | Name of the lending institution | | entity.score.loanPerformance\[].value\[].noOfNonPerforming | number | Count of non-performing loans | | entity.score.loanPerformance\[].value\[].noOfPerforming | number | Count of performing loans | | entity.score.loanPerformance\[].value\[].outstandingBalance | number | Remaining balance on the loan | | entity.score.loanPerformance\[].value\[].overdueAmount | number | Amount currently overdue | | entity.score.loanPerformance\[].value\[].performanceStatus | string | Loan performance status (e.g., `Performing`, `Non-Performing`) | | entity.score.loanPerformance\[].value\[].status | string | Current loan status (e.g., `Open`, `Closed`) | | entity.score.maxNoOfDays | array | Maximum number of days in delinquency per bureau | | entity.score.maxNoOfDays\[].source | string | Credit bureau source | | entity.score.maxNoOfDays\[].value | number\|null | Maximum days past due | | entity.score.totalBorrowed | array | Total amount borrowed per bureau | | entity.score.totalBorrowed\[].source | string | Credit bureau source | | entity.score.totalBorrowed\[].value | number | Total amount borrowed across all facilities | | entity.score.totalMonthlyInstallment | array | Total monthly installment obligations per bureau | | entity.score.totalMonthlyInstallment\[].source | string | Credit bureau source | | entity.score.totalMonthlyInstallment\[].value | number | Total monthly installment amount | | entity.score.totalNoOfActiveLoans | array | Count of active loans per bureau | | entity.score.totalNoOfActiveLoans\[].source | string | Credit bureau source | | entity.score.totalNoOfActiveLoans\[].value | number | Number of currently active loans | | entity.score.totalNoOfClosedLoans | array | Count of closed loans per bureau | | entity.score.totalNoOfClosedLoans\[].source | string | Credit bureau source | | entity.score.totalNoOfClosedLoans\[].value | number | Number of closed loans | | entity.score.totalNoOfDelinquentFacilities | array | Count of delinquent facilities per bureau | | entity.score.totalNoOfDelinquentFacilities\[].source | string | Credit bureau source | | entity.score.totalNoOfDelinquentFacilities\[].value | number | Number of delinquent credit facilities | | entity.score.totalNoOfInstitutions | array | Count of lending institutions per bureau | | entity.score.totalNoOfInstitutions\[].source | string | Credit bureau source | | entity.score.totalNoOfInstitutions\[].value | number | Number of institutions the individual has borrowed from | | entity.score.totalNoOfLoans | array | Total loan count per bureau | | entity.score.totalNoOfLoans\[].source | string | Credit bureau source | | entity.score.totalNoOfLoans\[].value | number | Total number of loans | | entity.score.totalNoOfOverdueAccounts | array | Count of overdue accounts per bureau | | entity.score.totalNoOfOverdueAccounts\[].source | string | Credit bureau source | | entity.score.totalNoOfOverdueAccounts\[].value | number | Number of accounts with overdue payments | | entity.score.totalNoOfPerformingLoans | array | Count of performing loans per bureau | | entity.score.totalNoOfPerformingLoans\[].source | string | Credit bureau source | | entity.score.totalNoOfPerformingLoans\[].value | number | Number of loans in good standing | | entity.score.totalOutstanding | array | Total outstanding balance per bureau | | entity.score.totalOutstanding\[].source | string | Credit bureau source | | entity.score.totalOutstanding\[].value | number | Total outstanding balance across all facilities | | entity.score.totalOverdue | array | Total overdue amount per bureau | | entity.score.totalOverdue\[].source | string | Credit bureau source | | entity.score.totalOverdue\[].value | number | Total overdue amount across all facilities | | entity.searchedDate | string | ISO 8601 timestamp of when the query was performed |