Credit Analysis
Get a full credit analysis
POST /api/v1/merchant/external/credit/analysis
This endpoint allows you to get a full analysis of a user's credit data
Headers
Name
Value
Content-Type
application/json
api-key
<your secret key>
Body
Name
Type
Description
Is Required
country
string
user country e.g NG
check_type
string
individual or cooperate
idnumber
string
e.g BVN No for nigeria
income
integer
estimated yearly income
loan
integer
propose loan amount to the user
is_sandbox
boolean
should be true to return a sample data
Response
{
"id": "0535b75d-b5c0-4592-831c-d96308a6a855",
"updated_at": "2024-10-15T09:13:43.897876Z",
"created_at": "2024-10-15T09:13:43.897901Z",
"response_data": {
"credit_data": [
{
"Scoring": [
{
"ConsumerID": "576565",
"RepaymentHistoryScore": "1002/192",
"TotalAmountOwedScore": "89/165",
"TypesOfCreditScore": "40/55",
"LengthOfCreditHistoryScore": "99/83",
"NoOfAcctScore": "33/55",
"TotalConsumerScore": "813",
"Description": "LOW RISK",
"ScoreDate": "10/15/2024"
}
]
},
{
"PersonalDetailsSummary": [
{
"Header": "PERSONAL DETAILS SUMMARY: test test",
"ConsumerID": 3232333,
"ReferenceNo": null,
"Nationality": "Nigeria",
"NationalIDNo": "",
"PassportNo": null,
"DriversLicenseNo": null,
"BankVerificationNo": "2222222222",
"PencomIDNo": "",
"otheridNo": "",
"BirthDate": "12/12/2004",
"Dependants": 0,
"Gender": "Male",
"MaritalStatus": null,
"ResidentialAddress1": "Lagos",
"ResidentialAddress2": "Nigeria",
"ResidentialAddress3": "",
"ResidentialAddress4": " ",
"PostalAddress1": null,
"PostalAddress2": null,
"PostalAddress3": null,
"PostalAddress4": null,
"HomeTelephoneNo": null,
"WorkTelephoneNo": null,
"CellularNo": "00000000000",
"EmailAddress": "",
"EmployerDetail": null,
"PropertyOwnedType": "",
"Surname": "test",
"FirstName": "test",
"OtherNames": "test"
}
]
},
{
"DeliquencyInformation": []
},
{
"CreditAccountSummary": [
{
"TotalMonthlyInstalment": "39,187.00",
"TotalOutstandingdebt": "0.00",
"TotalAccountarrear": "0",
"Amountarrear": "0.00",
"TotalAccounts": "3",
"TotalAccounts1": "0",
"TotalaccountinGodcondition": "3",
"TotalaccountinGoodcondition": "3",
"TotalNumberofJudgement": "0",
"TotalJudgementAmount": "0",
"LastJudgementDate": "-",
"TotalNumberofDishonoured": "0",
"TotalDishonouredAmount": "0.00",
"LastBouncedChequesDate": null,
"TotalMonthlyInstalment1": "0.00",
"TotalOutstandingdebt1": "0.00",
"TotalAccountarrear1": "0",
"Amountarrear1": "0.00",
"TotalaccountinGodcondition1": "0",
"TotalaccountinBadcondition": "0",
"TotalNumberofJudgement1": "0",
"TotalJudgementAmount1": "0",
"LastJudgementDate1": "-",
"TotalNumberofDishonoured1": "0",
"TotalDishonouredAmount1": "0.00",
"LastBouncedChequesDate1": null,
"Rating": "0"
}
]
},
{
"CreditAccountRating": [
{
"NoOfHomeLoanAccountsGood": 0,
"NoOfHomeLoanAccountsBad": 0,
"NoOfAutoLoanccountsGood": 0,
"NoOfAutoLoanAccountsBad": 0,
"NoOfStudyLoanAccountsGood": 0,
"NoOfStudyLoanAccountsBad": 0,
"NoOfPersonalLoanAccountsGood": 0,
"NoOfPersonalLoanAccountsBad": 0,
"NoOfCreditCardAccountsGood": 0,
"NoOfCreditCardAccountsBad": 0,
"NoOfRetailAccountsGood": 1,
"NoOfRetailAccountsBad": 0,
"NoOfJointLoanAccountsGood": 0,
"NoOfJointLoanAccountsBad": 0,
"NoOfTelecomAccountsGood": 0,
"NoOfTelecomAccountsBad": 0,
"NoOfOtherAccountsGood": 2,
"NoOfOtherAccountsBad": 0
}
]
},
{
"CreditAgreementSummary": [
{
"DateAccountOpened": "02/10/2019",
"SubscriberName": "Carbon Microfinance Bank Limited",
"AccountNo": "2222222222",
"SubAccountNo": "",
"IndicatorDescription": null,
"OpeningBalanceAmt": "1,500.00",
"Currency": "NGN",
"CurrentBalanceDebitInd": null,
"CurrentBalanceAmt": "0.00",
"InstalmentAmount": "1,950.00",
"AmountOverdue": "0.00",
"ClosedDate": "01/11/2019",
"LoanDuration": null,
"RepaymentFrequency": "Not Available",
"LastUpdatedDate": "22/03/2023",
"PerformanceStatus": "Performing",
"AccountStatus": "Closed"
},
{
"DateAccountOpened": "14/03/2020",
"SubscriberName": "Carbon Microfinance Bank Limited",
"AccountNo": "22222222222",
"SubAccountNo": "",
"IndicatorDescription": null,
"OpeningBalanceAmt": "6,500.00",
"Currency": "NGN",
"CurrentBalanceDebitInd": null,
"CurrentBalanceAmt": "0.00",
"InstalmentAmount": "7,806.50",
"AmountOverdue": "0.00",
"ClosedDate": "13/04/2020",
"LoanDuration": null,
"RepaymentFrequency": "Not Available",
"LastUpdatedDate": "24/10/2022",
"PerformanceStatus": "Performing",
"AccountStatus": "Closed"
},
{
"DateAccountOpened": "28/07/2021",
"SubscriberName": "Carbon Microfinance Bank Limited",
"AccountNo": "2222222222",
"SubAccountNo": "",
"IndicatorDescription": "Personal fixed term loan",
"OpeningBalanceAmt": "27,000.00",
"Currency": "NGN",
"CurrentBalanceDebitInd": null,
"CurrentBalanceAmt": "0.00",
"InstalmentAmount": "29,430.00",
"AmountOverdue": "0.00",
"ClosedDate": "12/08/2021",
"LoanDuration": null,
"RepaymentFrequency": "Not Available",
"LastUpdatedDate": "09/09/2022",
"PerformanceStatus": "Performing",
"AccountStatus": "Closed"
}
]
},
{
"AccountMonthlyPaymentHeader": [
{
"TableName": "Consumer24MonthlyPaymentHeader",
"DisplayText": "Consumer 24 Monthly Payment Header",
"Company": "Company",
"MH24": "2022\nNOV",
"MH23": "2022\nDEC",
"MH22": "2023\nJAN",
"MH21": "2023\nFEB",
"MH20": "2023\nMAR",
"MH19": "2023\nAPR",
"MH18": "2023\nMAY",
"MH17": "2023\nJUN",
"MH16": "2023\nJUL",
"MH15": "2023\nAUG",
"MH14": "2023\nSEP",
"MH13": "2023\nOCT",
"MH12": "2023\nNOV",
"MH11": "2023\nDEC",
"MH10": "2024\nJAN",
"MH09": "2024\nFEB",
"MH08": "2024\nMAR",
"MH07": "2024\nAPR",
"MH06": "2024\nMAY",
"MH05": "2024\nJUN",
"MH04": "2024\nJUL",
"MH03": "2024\nAUG",
"MH02": "2024\nSEP",
"MH01": "2024\nOCT"
}
]
},
{
"AccountMonthlyPaymentHistory": [
{
"Header": "Details of Credit Agreement with \"Carbon Microfinance Bank Limited\" for Account Number: 22222222222",
"TableName": "Consumer24MonthlyPayment",
"DisplayText": "Consumer 24 Monthly Payment",
"DateAccountOpened": "02/10/2019",
"SubscriberName": "Carbon Microfinance Bank Limited",
"AccountNo": "2222222222",
"SubAccountNo": "",
"Currency": "NGN",
"CurrentBalanceDebitInd": null,
"IndicatorDescription": null,
"OpeningBalanceAmt": "1,500.00",
"CurrentBalanceAmt": "0.00",
"MonthlyInstalmentAmt": "1,950.00",
"AmountOverdue": "0.00",
"ClosedDate": "01/11/2019",
"LastUpdatedDate": "22/03/2023",
"LastPaymentDate": null,
"PerformanceStatus": "Performing",
"SubscriberTypeInd": "E",
"AccountNote": "",
"LoanDuration": "Not Available",
"RepaymentFrequencyCode": "Not Available",
"AccountStatus": "Closed",
"M24": "#",
"M23": "0",
"M22": "#",
"M21": "0",
"M20": "#",
"M19": "#",
"M18": "#",
"M17": "#",
"M16": "#",
"M15": "#",
"M14": "#",
"M13": "#",
"M12": "#",
"M11": "#",
"M10": "#",
"M09": "#",
"M08": "#",
"M07": "#",
"M06": "#",
"M05": "#",
"M04": "#",
"M03": "#",
"M02": "#",
"M01": "#"
},
{
"Header": "Details of Credit Agreement with \"Carbon Microfinance Bank Limited\" for Account Number: 22222222222",
"TableName": "Consumer24MonthlyPayment",
"DisplayText": "Consumer 24 Monthly Payment",
"DateAccountOpened": "14/03/2020",
"SubscriberName": "Carbon Microfinance Bank Limited",
"AccountNo": "22222222222",
"SubAccountNo": "",
"Currency": "NGN",
"CurrentBalanceDebitInd": null,
"IndicatorDescription": null,
"OpeningBalanceAmt": "6,500.00",
"CurrentBalanceAmt": "0.00",
"MonthlyInstalmentAmt": "7,806.50",
"AmountOverdue": "0.00",
"ClosedDate": "13/04/2020",
"LastUpdatedDate": "24/10/2022",
"LastPaymentDate": null,
"PerformanceStatus": "Performing",
"SubscriberTypeInd": "E",
"AccountNote": "",
"LoanDuration": "Not Available",
"RepaymentFrequencyCode": "Not Available",
"AccountStatus": "Closed",
"M24": "#",
"M23": "#",
"M22": "#",
"M21": "#",
"M20": "#",
"M19": "#",
"M18": "#",
"M17": "#",
"M16": "#",
"M15": "#",
"M14": "#",
"M13": "#",
"M12": "#",
"M11": "#",
"M10": "#",
"M09": "#",
"M08": "#",
"M07": "#",
"M06": "#",
"M05": "#",
"M04": "#",
"M03": "#",
"M02": "#",
"M01": "#"
},
{
"Header": "Details of Credit Agreement with \"Carbon Microfinance Bank Limited\" for Account Number: 2223222222",
"TableName": "Consumer24MonthlyPayment",
"DisplayText": "Consumer 24 Monthly Payment",
"DateAccountOpened": "28/07/2021",
"SubscriberName": "Carbon Microfinance Bank Limited",
"AccountNo": "2222222222",
"SubAccountNo": "",
"Currency": "NGN",
"CurrentBalanceDebitInd": null,
"IndicatorDescription": "Personal fixed term loan",
"OpeningBalanceAmt": "27,000.00",
"CurrentBalanceAmt": "0.00",
"MonthlyInstalmentAmt": "29,430.00",
"AmountOverdue": "0.00",
"ClosedDate": "12/08/2021",
"LastUpdatedDate": "09/09/2022",
"LastPaymentDate": null,
"PerformanceStatus": "Performing",
"SubscriberTypeInd": "E",
"AccountNote": "",
"LoanDuration": "Not Available",
"RepaymentFrequencyCode": "Not Available",
"AccountStatus": "Closed",
"M24": "#",
"M23": "#",
"M22": "#",
"M21": "#",
"M20": "#",
"M19": "#",
"M18": "#",
"M17": "#",
"M16": "#",
"M15": "#",
"M14": "#",
"M13": "#",
"M12": "#",
"M11": "#",
"M10": "#",
"M09": "#",
"M08": "#",
"M07": "#",
"M06": "#",
"M05": "#",
"M04": "#",
"M03": "#",
"M02": "#",
"M01": "#"
}
]
},
{
"GuarantorCount": [
{
"GuarantorsSecured": 0,
"Accounts": 0
}
]
},
{
"IdentificationHistory": [
{
"UpDateDate": "",
"UpDateOnDate": "",
"IdentificationNumber": "",
"IdentificationType": ""
}
]
},
{
"AddressHistory": [
{
"UpDateDate": "20/12/2019",
"UpDateOnDate": "20/12/2019",
"Address1": "",
"Address2": null,
"Address3": null,
"Address4": null,
"AddressTypeInd": "Residential"
},
{
"UpDateDate": "08/12/2021",
"UpDateOnDate": "08/12/2021",
"Address1": "",
"Address2": "",
"Address3": null,
"Address4": null,
"AddressTypeInd": ""
}
]
},
{
"GuarantorDetails": [
{
"GuarantorFirstName": "",
"GuarantorOtherName": "",
"GuarantorNationalIDNo": "",
"GuarantorPassport": "",
"GuarantorDriverLicenceNo": "",
"GuarantorPENCOMIDNo": "",
"GuarantorOtherID": "",
"GuarantorGender": "",
"GuarantorDateOfBirth": "",
"GuarantorAddress1": "",
"GuarantorAddress2": "",
"GuarantorAddress3": "",
"GuarantorHomeTelephone": "",
"GuarantorworkTelephone": "",
"GuarantorMobileTelephone": ""
}
]
},
{
"EmploymentHistory": [
{
"UpDateDate": "",
"UpDateOnDate": "",
"EmployerDetail": "",
"Occupation": ""
}
]
},
{
"TelephoneHistory": [
{
"HomeNoUpdatedonDate": null,
"HomeTelephoneNumber": null,
"WorkNoUpdatedonDate": null,
"WorkTelephoneNumber": null,
"MobileNoUpdatedonDate": "",
"MobileTelephoneNumber": ""
}
]
},
{
"EnquiryDetails": [
{
"SubscriberEnquiryResultID": null,
"ProductID": null,
"MatchingRate": null,
"SubscriberEnquiryEngineID": null
}
]
}
],
"ai_analysis": {
"confidence": 1.0,
"will_default": true,
"description": "The applicant will default on a loan",
"info": {
"analysis": {
"description": "Based on the provided data, the applicant is predicted to default on the loan.",
"points": [
"The applicant's probability of defaulting is very high (1.0), indicating a significant risk for the lender.",
"The income of the applicant (200,000 Naira) may not be sufficient to support the loan amount of 100,000 Naira, leading to a higher chance of default.",
"The young age of the applicant (26 years) without a substantial credit history might also contribute to the increased default risk.",
"The probability of not defaulting is 0.0, further reinforcing the prediction of loan default.",
"Lenders may view the combination of factors as high-risk, resulting in the negative loan approval decision."
]
},
"advice": {
"description": "To improve the chances of loan approval and reduce the risk of default, the applicant should consider the following actions:",
"points": [
"Increase income or consider a lower loan amount to ensure better affordability and reduce the risk of default.",
"Build a stronger credit history by managing existing debts responsibly and making timely payments on any credit accounts.",
"Consider adding a co-signer with a more established credit history or higher income to strengthen the loan application.",
"Provide additional documentation or proof of financial stability to reassure lenders about the ability to repay the loan.",
"Explore alternative lending options or financial products that may be more suitable based on the current financial situation.",
"Seek financial advice or credit counseling to better understand and improve creditworthiness for future loan applications."
]
}
}
},
"blacklist": [],
"credit_score": {
"score": 655.0,
"max_score": 999,
"description": "This score provides valuable insights into user credit health, aiding in your financial decisions.",
"influences": {
"positive": 6,
"negative": 1
},
"weight_contributions": {
"age": 40.0,
"employment_status": -40.0,
"income": 40.0,
"credit_utilization_ratio": 105.0,
"loan_repayment_history": 60.0,
"debt_to_income_ratio": 100.0,
"documents_verified": 50
}
}
},
"request_data": {
"country": "NG",
"check_type": "individual",
"idnumber": "22222222222",
"income": "200000",
"loan": "100000"
},
"response_code": "00",
"price": "1000",
"status": true,
"billed": true
}
```{
"status":false,
"detail": "You have an insufficient balance"
}Last updated