Credit Bureau Consumer(Individual)-Advance

Get advance credit details of a user

With this endpoint, businesses can gain a deeper understanding of their customers' financial behavior and make informed decisions about extending credit. You can get a comprehensive view of each customer's account, so you can better assess their creditworthiness and mitigate risk.

Even more, businesses will receive a wealth of information about each customer, including their repayment history score, number of accounts, and total outstanding debts, while gaining access to valuable data such as the email address associated with each account, and ultimately reducing the risk of fraudulent activity.

To use this endpoint, you need to provide these customer details- bank details, name, date of birth, and reference.

👍
TEST DATA
mode: ID
number: 22222222222
customer_name: Test Name
dob: 1990-08-01
customer_reference: 327395393

📘
POST
{{URL}}/identitypass/verification/credit_bureau/consumer/advance

Request Header

Key	Description
app-id	Your App ID
x-api-key	Your Secret Key

Request Body

Key	Description
mode	either ID or BIO
number	if mode is ID(Should be a BVN)
dob	if mode is BIO(Date of Birth)
customer_name	Your customer's name
customer_reference	Unique customer reference

Sample Response

{
    "status": true,
    "detail": "Credit Check successful",
    "response_code": "00",
    "data": [
        {
            "SubjectList": [
                {
                    "ConsumerID": "2599049",
                    "SearchOutput": "Amos, Testi, , College Road Abaro Aladje",
                    "Reference": "2599049"
                }
            ]
        },
        {
            "PersonalDetailsSummary": [
                {
                    "ConsumerID": "2599049",
                    "Header": "PERSONAL DETAILS SUMMARY: Amos Testi ",
                    "ReferenceNo": null,
                    "Nationality": "Nigeria",
                    "NationalIDNo": "",
                    "PassportNo": null,
                    "DriversLicenseNo": null,
                    "BankVerificationNo": "22471069115",
                    "PencomIDNo": "",
                    "OtheridNo": "",
                    "BirthDate": "26/01/1977",
                    "Dependants": "0",
                    "Gender": "Female",
                    "MaritalStatus": null,
                    "ResidentialAddress1": "College Road Abaro Aladje",
                    "ResidentialAddress2": "Delta",
                    "ResidentialAddress3": "",
                    "ResidentialAddress4": " ",
                    "PostalAddress1": null,
                    "PostalAddress2": null,
                    "PostalAddress3": null,
                    "PostalAddress4": null,
                    "HomeTelephoneNo": null,
                    "WorkTelephoneNo": null,
                    "CellularNo": "",
                    "EmailAddress": "",
                    "EmployerDetail": null,
                    "PropertyOwnedType": "",
                    "Surname": "Amos",
                    "FirstName": "Testi",
                    "OtherNames": ""
                }
            ]
        },
        {
            "CreditAccountSummary": [
                {
                    "TotalMonthlyInstalment": "17,205.00",
                    "TotalOutstandingdebt": "66,586.00",
                    "TotalAccountarrear": "2",
                    "Amountarrear": "0.00",
                    "TotalAccounts": "6",
                    "TotalAccounts1": "0",
                    "TotalaccountinGodcondition": "5",
                    "TotalaccountinGoodcondition": "5",
                    "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": "118"
                }
            ]
        },
        {
            "AccountRating": [
                {
                    "NoOfHomeLoanAccountsGood": "0",
                    "NoOfHomeLoanAccountsBad": "0",
                    "NoOfAutoLoanccountsGood": "0",
                    "NoOfAutoLoanAccountsBad": "0",
                    "NoOfStudyLoanAccountsGood": "0",
                    "NoOfStudyLoanAccountsBad": "0",
                    "NoOfPersonalLoanAccountsGood": "0",
                    "NoOfPersonalLoanAccountsBad": "0",
                    "NoOfCreditCardAccountsGood": "0",
                    "NoOfCreditCardAccountsBad": "0",
                    "NoOfRetailAccountsGood": "0",
                    "NoOfRetailAccountsBad": "0",
                    "NoOfJointLoanAccountsGood": "0",
                    "NoOfJointLoanAccountsBad": "0",
                    "NoOfTelecomAccountsGood": "0",
                    "NoOfTelecomAccountsBad": "0",
                    "NoOfOtherAccountsGood": "6",
                    "NoOfOtherAccountsBad": "0"
                }
            ]
        },
        {
            "EnquiryDetails": [
                {
                    "SubscriberEnquiryResultID": null,
                    "ProductID": null,
                    "MatchingRate": null,
                    "SubscriberEnquiryEngineID": null
                }
            ]
        }
    ]
}

Response Description

Response	Description
SubjectList	This is an array of objects that represent the results of the CAC search. Each object contains information about a consumer's details.
ConsumerID	The unique identifier for the consumer.
Header	The header of the consumer details.
ReferenceNo	A reference number for the consumer details.
PersonalDetailsSummary	This is an object that represents the personal details summary for a consumer. It contains various personal details of the consumer.
Nationality	The nationality of the consumer.
NationalIDNo	The national ID number of the consumer.
PassportNo	The passport number of the consumer.
DriversLicenseNo	The driver's license number of the consumer.
BankVerificationNo	The bank verification number of the consumer.
PencomIDNo	The Pencom ID number of the consumer.
OtheridNo	Any other ID number of the consumer.
BirthDate	The date of birth of the consumer.
Dependants	The number of dependants of the consumer.
Gender	The gender of the consumer.
MaritalStatus	The marital status of the consumer.
ResidentialAddress1	The first line of the consumer's residential address.
ResidentialAddress2	The second line of the consumer's residential address.
ResidentialAddress3	The third line of the consumer's residential address.
ResidentialAddress4	The fourth line of the consumer's residential address.
PostalAddress1	The first line of the consumer's postal address.
PostalAddress2	The second line of the consumer's postal address.
PostalAddress3	The third line of the consumer's postal address.
PostalAddress4	The fourth line of the consumer's postal address.
HomeTelephoneNo	The consumer's home telephone number.
WorkTelephoneNo	The consumer's work telephone number.
CellularNo	The consumer's cellular number.
EmailAddress	The consumer's email address.
EmployerDetail	The employer details of the consumer.
PropertyOwnedType	The type of property that the consumer owns.
Surname	The surname of the consumer.
FirstName	The first name of the consumer.
OtherNames	Any other names of the consumer.
CreditAccountSummary	This is an array of objects that represent the credit account summary for the consumer. Each object contains information about the consumer's credit accounts.
TotalMonthlyInstalment	The total monthly installment amount for all of the consumer's accounts.
TotalOutstandingdebt	The total outstanding debt for all of the consumer's accounts.
TotalAccountarrear	The total number of accounts that are in arrears.
Amountarrear	The total amount of money that is owed on the accounts that are in arrears.
TotalAccounts	The total number of accounts that the consumer has.
TotalAccounts1	The total number of accounts that are in good standing.
TotalaccountinGoodcondition	The total number of accounts that are in good condition.
TotalNumberofJudgement	The total number of judgments that have been issued against the consumer.
TotalJudgementAmount	The total amount of money that is owed on the judgments that have been issued against the consumer.
LastJudgementDate	The date of the most recent judgment that was issued against the consumer.
TotalNumberofDishonoured	The total number of times that the consumer has had a check or a payment bounced.
TotalDishonouredAmount	The total amount of money that has been lost due to bounced checks or payments.
LastBouncedChequesDate	The date of the most recent bounced check or payment.
Rating	The consumer's credit rating.
AccountRating	This is an array that contains multiple objects, one for each type of account that the consumer has. Each object contains information about the number of accounts the consumer has in good and bad standing for different account types.
NoOfHomeLoanAccountsGood	The number of home loan accounts that the consumer has in good standing.
NoOfHomeLoanAccountsBad	The number of home loan accounts that the consumer has in bad standing.
NoOfAutoLoanccountsGood	The number of auto loan accounts that the consumer has in good standing.
NoOfAutoLoanAccountsBad	The number of auto loan accounts that the consumer has in bad standing.
NoOfStudyLoanAccountsGood	The number of study loan accounts that the consumer has in good standing.
NoOfStudyLoanAccountsBad	The number of study loan accounts that the consumer has in bad standing.
NoOfPersonalLoanAccountsGood	The number of personal loan accounts that the consumer has in good standing.
NoOfPersonalLoanAccountsBad	The number of personal loan accounts that the consumer has in bad standing.
NoOfCreditCardAccountsGood	The number of credit card accounts that the consumer has in good standing.
NoOfCreditCardAccountsBad	The number of credit card accounts that the consumer has in bad standing.
NoOfRetailAccountsGood	The number of retail accounts that the consumer has in good standing.
NoOfRetailAccountsBad	The number of retail accounts that the consumer has in bad standing.
NoOfJointLoanAccountsGood	The number of joint loan accounts that the consumer has in good standing.
NoOfJointLoanAccountsBad	The number of joint loan accounts that the consumer has in bad standing.
NoOfTelecomAccountsGood	The number of telecom accounts that the consumer has in good standing.
NoOfTelecomAccountsBad	The number of telecom accounts that the consumer has in bad standing.
NoOfOtherAccountsGood	The number of other accounts that the consumer has in good standing.
NoOfOtherAccountsBad	The number of other accounts that the consumer has in bad standing.
EnquiryDetails	This is an array of multiple objects, one for each enquiry that the consumer has made. Each object contains information about a specific enquiry.
SubscriberEnquiryResultID	The unique identifier for the enquiry result.
ProductID	The ID of the product that the consumer enquired about.
MatchingRate	The rate at which the consumer's credit profile matches the criteria for the product.
SubscriberEnquiryEngineID	The ID of the engine that processed the enquiry.pecific enquiry.

Updated 2 months ago

Credit Bureau Consumer(Individual)-Advance

👍
TEST DATA

📘
POST

Sample Response

Response Description

👍TEST DATA

📘POST

Sample Response

Response Description

👍
TEST DATA

📘
POST