Credit Bureau Consumer(Individual)-Basic

Basic consumer credit bureau endpoint

This endpoint enables businesses to quickly and accurately verify users' creditworthiness. It allows you to check whether a customer's basic details match their account details, ensuring that the person using the account is indeed the same person who created it.

This is especially useful for businesses in the loan space as it ensures that their customers are who they say they are and that they're not using stolen or fraudulent accounts to access your services. By verifying a customerโ€™s credit worthiness, you can reduce the risk of fraud, and protect your business.

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

๐Ÿ‘

TEST DATA

mode: ID

number: 11111111111

customer_name: Test Name

dob: 1990-08-01

customer_reference: 327395393

๐Ÿ“˜

POST

{{URL}}/identitypass/verification/credit_bureau/consumer/basic

Request Header

KeyDescription
app-idYour App ID
x-api-keyYour Secret Key

Request Body

KeyDescription
modeID or BIO
numberif mode is ID(Should be a BVN)
dobif mode is BIO(Date of Birth)
customer_nameYour customer's name
customer_referenceUnique 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

ResponseDescription
statusIndicates that the request was successful.
detailThis field indicates the detail of the response.
response_codeRepresents the response code.
dataIt is a string that contains some encrypted or encoded data related to the verification.
SubjectListThis is an array of objects that represent the results of the CAC search.
ConsumerIDThe unique identifier for the consumer.
SearchOutputThe output of the search, which in this case is the name and address of the consumer.
ReferenceA reference number that can be used to track the search request.
PersonalDetailsSummaryThis is an object that represents the personal details summary for a consumer.
ConsumerIDThe unique identifier for the consumer.
HeaderA header that contains the consumer's name.
ReferenceNoA reference number for the personal details summary.
NationalityThe consumer's nationality.
NationalIDNoThe consumer's national ID number.
PassportNoThe consumer's passport number.
DriversLicenseNoThe consumer's driver's license number.
BankVerificationNoThe consumer's bank verification number.
PencomIDNoThe consumer's Pencom ID number.
OtheridNoThe consumer's other ID number.
BirthDateThe consumer's birth date.
DependantsThe number of dependants the consumer has.
GenderThe consumer's gender.
MaritalStatusThe consumer's marital status.
ResidentialAddress1The consumer's residential address.
ResidentialAddress2The consumer's secondary residential address.
ResidentialAddress3The consumer's tertiary residential address.
PostalAddress1The consumer's postal address.
PostalAddress2The consumer's secondary postal address.
PostalAddress3The consumer's tertiary postal address.
HomeTelephoneNoThe consumer's home telephone number.
WorkTelephoneNoThe consumer's work telephone number.
CellularNoThe consumer's cellular number.
EmailAddressThe consumer's email address.
EmployerDetailThe consumer's employer details.
PropertyOwnedTypeThe type of property the consumer owns.
SurnameThe consumer's surname.
FirstNameThe consumer's first name.
OtherNamesThe consumer's other names.
CreditAccountSummaryThis is an array of objects that represent the credit account summary for the consumer.
TotalMonthlyInstalmentThe total monthly installment for all of the consumer's credit accounts.
TotalOutstandingdebtThe total outstanding debt for all of the consumer's credit accounts.
TotalAccountarrearThe total number of accounts that are in arrears.
AmountarrearThe total amount of debt that is in arrears.
TotalAccountsThe total number of credit accounts that the consumer has.
TotalAccounts1The total number of credit accounts that are in good condition.
TotalaccountinGodconditionThe total number of credit accounts that are in bad condition.
TotalNumberofJudgementThe total number of judgments against the consumer.
TotalJudgementAmountThe total amount of debt that is owed due to judgments against the consumer.
LastJudgementDateThe date of the most recent judgment against the consumer.
TotalNumberofDishonouredThe total number of bounced cheques that the consumer has written.
TotalDishonouredAmountThe total amount of money that the consumer owes due to bounced cheques.
LastBouncedChequesDateThe date of the most recent bounced cheque.
RatingThe consumer's credit rating.
AccountRatingThis is an array that contains multiple objects, one for each type of account that the consumer has.
NoOfHomeLoanAccountsGoodThe number of home loan accounts that the consumer has in good standing.
NoOfHomeLoanAccountsBadThe number of home loan accounts that the consumer has in bad standing.
NoOfAutoLoanccountsGoodThe number of auto loan accounts that the consumer has in good standing.
NoOfAutoLoanAccountsBadThe number of auto loan accounts that the consumer has in bad standing.
NoOfStudyLoanAccountsGoodThe number of study loan accounts that the consumer has in good standing.
NoOfStudyLoanAccountsBadThe number of study loan accounts that the consumer has in bad standing.
NoOfPersonalLoanAccountsGoodThe number of personal loan accounts that the consumer has in good standing.
NoOfPersonalLoanAccountsBadThe number of personal loan accounts that the consumer has in bad standing.
NoOfCreditCardAccountsGoodThe number of credit card accounts that the consumer has in good standing.
NoOfCreditCardAccountsBadThe number of credit card accounts that the consumer has in bad standing.
NoOfRetailAccountsGoodThe number of retail accounts that the consumer has in good standing.
NoOfRetailAccountsBadThe number of retail accounts that the consumer has in bad standing.
NoOfJointLoanAccountsGoodThe number of joint loan accounts that the consumer has in good standing.
NoOfJointLoanAccountsBadThe number of joint loan accounts that the consumer has in bad standing.
NoOfTelecomAccountsGoodThe number of telecom accounts that the consumer has in good standing.
NoOfTelecomAccountsBadThe number of telecom accounts that the consumer has in bad standing.
NoOfOtherAccountsGoodThe number of other accounts that the consumer has in good standing.
NoOfOtherAccountsBadThe number of other accounts that the consumer has in bad standing.
EnquiryDetailsThis is an array of multiple objects, one for each enquiry that the consumer has made.
SubscriberEnquiryResultIDThe unique identifier for the enquiry result.
ProductIDThe ID of the product that the consumer enquired about.
MatchingRateThe rate at which the consumer's credit profile matches the criteria for the product.
SubscriberEnquiryEngineIDThe ID of the engine that processed the enquiry.
Face_dataThis field contains information related to the face matching process. It provides details about the result of comparing two faces and determining if they match or not.
statusThis field indicates the overall status of the face matching process.
messageThis field contains a human-readable message that describes the result of the face matching process.
confidenceThis field represents the level of confidence or certainty associated with the face matching result.