Advance
Last updated
Last updated
TEST DATA mode:ID customer_name:Test Name number:22222222222 dob:1990-08-01
POST {{BASE_URL}}/api/v2/biometrics/merchant/data/verification/credit_bureau/consumer/advance
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
{
"status": true,
"detail": "Credit Check successful",
"response_code": "00",
"data": [
{
"Scoring": [
{
"ConsumerID": "",
"RepaymentHistoryScore": "",
"TotalAmountOwedScore": "",
"TypesOfCreditScore": "",
"LengthOfCreditHistoryScore": "",
"NoOfAcctScore": "",
"TotalConsumerScore": "",
"Description": "",
"ScoreDate": ""
}
]
},
{
"PersonalDetailsSummary": [
{
"ConsumerID": "",
"Header": "",
"ReferenceNo": "",
"Nationality": "",
"NationalIDNo": "",
"PassportNo": null,
"DriversLicenseNo": null,
"BankVerificationNo": "",
"PencomIDNo": "",
"OtheridNo": "",
"BirthDate": "",
"Dependants": "0",
"Gender": "",
"MaritalStatus": null,
"ResidentialAddress1": "",
"ResidentialAddress2": "",
"ResidentialAddress3": "",
"ResidentialAddress4": "",
"PostalAddress1": null,
"PostalAddress2": null,
"PostalAddress3": null,
"PostalAddress4": null,
"HomeTelephoneNo": null,
"WorkTelephoneNo": null,
"CellularNo": "",
"EmailAddress": "",
"EmployerDetail": null,
"PropertyOwnedType": "",
"Surname": "",
"FirstName": "",
"OtherNames": ""
}
]
},
{
"DeliquencyInformation": [
{
"SubscriberName": "",
"AccountNo": "",
"PeriodNum": "",
"MonthsinArrears": ""
}
]
},
{
"CreditAccountSummary": [
{
"TotalMonthlyInstalment": "",
"TotalOutstandingdebt": "0.00",
"TotalAccountarrear": "0",
"Amountarrear": "0.00",
"TotalAccounts": "",
"TotalAccounts1": "0",
"TotalaccountinGodcondition": "",
"TotalaccountinGoodcondition": "",
"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": "2",
"NoOfRetailAccountsBad": "0",
"NoOfJointLoanAccountsGood": "0",
"NoOfJointLoanAccountsBad": "0",
"NoOfTelecomAccountsGood": "0",
"NoOfTelecomAccountsBad": "0",
"NoOfOtherAccountsGood": "0",
"NoOfOtherAccountsBad": "0"
}
]
},
{
"CreditAgreementSummary": [
{
"DateAccountOpened": "",
"SubscriberName": "Access Bank",
"AccountNo": "",
"SubAccountNo": "",
"IndicatorDescription": "",
"OpeningBalanceAmt": "",
"Currency": "NGN",
"CurrentBalanceDebitInd": null,
"CurrentBalanceAmt": "0.00",
"InstalmentAmount": "",
"AmountOverdue": "0.00",
"ClosedDate": "",
"LoanDuration": "",
"RepaymentFrequency": "",
"LastUpdatedDate": "",
"PerformanceStatus": "",
"AccountStatus": ""
},
{
"DateAccountOpened": "",
"SubscriberName": "Access Bank Plc Lagos",
"AccountNo": "",
"SubAccountNo": "",
"IndicatorDescription": "",
"OpeningBalanceAmt": "",
"Currency": "NGN",
"CurrentBalanceDebitInd": "D",
"CurrentBalanceAmt": "0.00",
"InstalmentAmount": "0.00",
"AmountOverdue": "0.00",
"ClosedDate": "",
"LoanDuration": "",
"RepaymentFrequency": "",
"LastUpdatedDate": "",
"PerformanceStatus": "",
"AccountStatus": ""
},
{
"DateAccountOpened": "",
"SubscriberName": "Access Bank ",
"AccountNo": "",
"SubAccountNo": "",
"IndicatorDescription": "",
"OpeningBalanceAmt": "",
"Currency": "NGN",
"CurrentBalanceDebitInd": null,
"CurrentBalanceAmt": "0.00",
"InstalmentAmount": null,
"AmountOverdue": "0.00",
"ClosedDate": "",
"LoanDuration": "",
"RepaymentFrequency": "",
"LastUpdatedDate": "",
"PerformanceStatus": "",
"AccountStatus": ""
}
]
},
{
"AccountMonthlyPaymentHistoryHeader": [
{
"TableName": "",
"DisplayText": "",
"Company": "",
"MH24": "",
"MH23": "",
"MH22": "",
"MH21": "",
"MH20": "",
"MH19": "",
"MH18": "",
"MH17": "",
"MH16": "",
"MH15": "",
"MH14": "",
"MH13": "",
"MH12": "",
"MH11": "",
"MH10": "",
"MH09": "",
"MH08": "",
"MH07": "",
"MH06": "",
"MH05": "",
"MH04": "",
"MH03": "",
"MH02": "",
"MH01": ""
}
]
},
{
"AccountMonthlyPaymentHistory": [
{
"Header": "Details of Credit Agreement with \"Access Bank Plc Lagos\" for Account Number: 099PDLP2009001G9",
"TableName": "Consumer24MonthlyPayment",
"DisplayText": "Consumer 24 Monthly Payment",
"DateAccountOpened": "",
"SubscriberName": "",
"AccountNo": "",
"SubAccountNo": "",
"Currency": "NGN",
"CurrentBalanceDebitInd": null,
"IndicatorDescription": "Personal fixed term loan",
"MonthlyInstalmentAmt": "",
"LastPaymentDate": "",
"SubscriberTypeInd": "C",
"AccountNote": "",
"RepaymentFrequencyCode": "Not Available",
"OpeningBalanceAmt": "19,000.00",
"CurrentBalanceAmt": "0.00",
"AmountOverdue": "0.00",
"ClosedDate": "",
"LastUpdatedDate": "",
"PerformanceStatus": "Performing",
"LoanDuration": "30 Day(s)",
"AccountStatus": "",
"M01": "#",
"M02": "#",
"M03": "#",
"M04": "#",
"M05": "#",
"M06": "#",
"M07": "#",
"M08": "#",
"M09": "#",
"M10": "#",
"M11": "#",
"M12": "#",
"M13": "#",
"M14": "#",
"M15": "#",
"M16": "#",
"M17": "#",
"M18": "#",
"M19": "#",
"M20": "#",
"M21": "#",
"M22": "#",
"M23": "#",
"M24": "#"
},
{
"Header": "Details of Credit Agreement with \"Access Bank Plc Lagos\" for Account Number: 099PDLP201530DJZ",
"TableName": "Consumer24MonthlyPayment",
"DisplayText": "Consumer 24 Monthly Payment",
"DateAccountOpened": "",
"SubscriberName": "Access Bank Plc Lagos",
"AccountNo": "",
"SubAccountNo": "",
"Currency": "NGN",
"CurrentBalanceDebitInd": "D",
"IndicatorDescription": "Personal fixed term loan",
"MonthlyInstalmentAmt": "0.00",
"LastPaymentDate": null,
"SubscriberTypeInd": "C",
"AccountNote": "",
"RepaymentFrequencyCode": "Not Available",
"OpeningBalanceAmt": "19,000.00",
"CurrentBalanceAmt": "0.00",
"AmountOverdue": "0.00",
"ClosedDate": "01/07/2020",
"LastUpdatedDate": "",
"PerformanceStatus": "Performing",
"LoanDuration": "30 Day(s)",
"AccountStatus": "Closed",
"M01": "#",
"M02": "#",
"M03": "#",
"M04": "#",
"M05": "#",
"M06": "#",
"M07": "#",
"M08": "#",
"M09": "#",
"M10": "#",
"M11": "#",
"M12": "#",
"M13": "#",
"M14": "#",
"M15": "#",
"M16": "#",
"M17": "#",
"M18": "#",
"M19": "#",
"M20": "#",
"M21": "#",
"M22": "#",
"M23": "#",
"M24": "#"
},
{
"Header": "Details of Credit Agreement with \"Access Bank Plc Lagos\" for Account Number: 099PDLP202790KBV",
"TableName": "Consumer24MonthlyPayment",
"DisplayText": "Consumer 24 Monthly Payment",
"DateAccountOpened": "10/05/2020",
"SubscriberName": "Access Bank",
"AccountNo": "",
"SubAccountNo": "",
"Currency": "NGN",
"CurrentBalanceDebitInd": null,
"IndicatorDescription": "Payday Loan or salary advance",
"MonthlyInstalmentAmt": null,
"LastPaymentDate": null,
"SubscriberTypeInd": "C",
"AccountNote": "",
"RepaymentFrequencyCode": "Not Available",
"OpeningBalanceAmt": "19,000.00",
"CurrentBalanceAmt": "0.00",
"AmountOverdue": "0.00",
"ClosedDate": "11/04/2020",
"LastUpdatedDate": "12/06/2022",
"PerformanceStatus": "Performing",
"LoanDuration": "30 Day(s)",
"AccountStatus": "Closed",
"M01": "#",
"M02": "#",
"M03": "#",
"M04": "#",
"M05": "#",
"M06": "#",
"M07": "#",
"M08": "#",
"M09": "0",
"M10": "#",
"M11": "391",
"M12": "361",
"M13": "330",
"M14": "300",
"M15": "269",
"M16": "#",
"M17": "0",
"M18": "#",
"M19": "147",
"M20": "0",
"M21": "88",
"M22": "57",
"M23": "26",
"M24": "0"
}
]
},
{
"GuarantorCount": [
{
"GuarantorsSecured": "0",
"Accounts": "0"
}
]
},
{
"GuarantorDetails": [
{
"GuarantorFirstName": "",
"GuarantorOtherName": "",
"GuarantorNationalIDNo": "",
"GuarantorPassport": "",
"GuarantorDriverLicenceNo": "",
"GuarantorPENCOMIDNo": "",
"GuarantorOtherID": "",
"GuarantorGender": "",
"GuarantorDateOfBirth": "",
"GuarantorAddress1": "",
"GuarantorAddress2": "",
"GuarantorAddress3": "",
"GuarantorHomeTelephone": "",
"GuarantorworkTelephone": "",
"GuarantorMobileTelephone": ""
}
]
},
{
"CompanyDirectorSummary": null
},
{
"IdentificationHistory": [
{
"UpDateDate": null,
"UpDateOnDate": null,
"IdentificationNumber": null,
"IdentificationType": null
}
]
},
{
"AddressHistory": [
{
"UpDateDate": "",
"UpDateOnDate": "",
"Address1": "",
"Address2": null,
"Address3": "",
"Address4": null,
"AddressTypeInd": ""
},
{
"UpDateDate": "",
"UpDateOnDate": "",
"Address1": "ACCESS BANK PLC PLOT 1665 OYIN JOLAYEMI STREET VISLAND",
"Address2": "",
"Address3": null,
"Address4": null,
"AddressTypeInd": ""
},
{
"UpDateDate": "",
"UpDateOnDate": "",
"Address1": "NO 50B OKE OLU STREET IGANMULagos State",
"Address2": null,
"Address3": null,
"Address4": null,
"AddressTypeInd": ""
},
{
"UpDateDate": "",
"UpDateOnDate": "",
"Address1": "",
"Address2": null,
"Address3": null,
"Address4": null,
"AddressTypeInd": ""
},
{
"UpDateDate": "",
"UpDateOnDate": "",
"Address1": "",
"Address2": null,
"Address3": null,
"Address4": "",
"AddressTypeInd": ""
}
]
},
{
"EmploymentHistory": [
{
"UpDateDate": null,
"UpDateOnDate": null,
"EmployerDetail": null,
"Occupation": null
}
]
},
{
"TelephoneHistory": [
{
"HomeNoUpdatedonDate": null,
"HomeTelephoneNumber": null,
"WorkNoUpdatedonDate": null,
"WorkTelephoneNumber": null,
"MobileNoUpdatedonDate": "",
"MobileTelephoneNumber": ""
}
]
}
]
}x-api-key*
String
your secret key
app-id*
String
your app id
mode*
String
either ID or BIO
number*
String
if mode is ID(Should be a BVN)
String
dob
String
if mode is BIO(Date of Birth)
customer_name
String
name of customer
customer_reference
String
unique customer reference