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
Key | Description |
---|---|
app-id | Your App ID |
x-api-key | Your Secret Key |
Request Body
Key | Description |
---|---|
mode | 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 |
---|---|
status | Indicates that the request was successful. |
detail | This field indicates the detail of the response. |
response_code | Represents the response code. |
data | It is a string that contains some encrypted or encoded data related to the verification. |
SubjectList | This is an array of objects that represent the results of the CAC search. |
ConsumerID | The unique identifier for the consumer. |
SearchOutput | The output of the search, which in this case is the name and address of the consumer. |
Reference | A reference number that can be used to track the search request. |
PersonalDetailsSummary | This is an object that represents the personal details summary for a consumer. |
ConsumerID | The unique identifier for the consumer. |
Header | A header that contains the consumer's name. |
ReferenceNo | A reference number for the personal details summary. |
Nationality | The consumer's nationality. |
NationalIDNo | The consumer's national ID number. |
PassportNo | The consumer's passport number. |
DriversLicenseNo | The consumer's driver's license number. |
BankVerificationNo | The consumer's bank verification number. |
PencomIDNo | The consumer's Pencom ID number. |
OtheridNo | The consumer's other ID number. |
BirthDate | The consumer's birth date. |
Dependants | The number of dependants the consumer has. |
Gender | The consumer's gender. |
MaritalStatus | The consumer's marital status. |
ResidentialAddress1 | The consumer's residential address. |
ResidentialAddress2 | The consumer's secondary residential address. |
ResidentialAddress3 | The consumer's tertiary residential address. |
PostalAddress1 | The consumer's postal address. |
PostalAddress2 | The consumer's secondary postal address. |
PostalAddress3 | The consumer's tertiary 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 consumer's employer details. |
PropertyOwnedType | The type of property the consumer owns. |
Surname | The consumer's surname. |
FirstName | The consumer's first name. |
OtherNames | The consumer's other names. |
CreditAccountSummary | This is an array of objects that represent the credit account summary for the consumer. |
TotalMonthlyInstalment | The total monthly installment for all of the consumer's credit accounts. |
TotalOutstandingdebt | The total outstanding debt for all of the consumer's credit accounts. |
TotalAccountarrear | The total number of accounts that are in arrears. |
Amountarrear | The total amount of debt that is in arrears. |
TotalAccounts | The total number of credit accounts that the consumer has. |
TotalAccounts1 | The total number of credit accounts that are in good condition. |
TotalaccountinGodcondition | The total number of credit accounts that are in bad condition. |
TotalNumberofJudgement | The total number of judgments against the consumer. |
TotalJudgementAmount | The total amount of debt that is owed due to judgments against the consumer. |
LastJudgementDate | The date of the most recent judgment against the consumer. |
TotalNumberofDishonoured | The total number of bounced cheques that the consumer has written. |
TotalDishonouredAmount | The total amount of money that the consumer owes due to bounced cheques. |
LastBouncedChequesDate | The date of the most recent bounced cheque. |
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. |
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. |
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. |
Face_data | This 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. |
status | This field indicates the overall status of the face matching process. |
message | This field contains a human-readable message that describes the result of the face matching process. |
confidence | This field represents the level of confidence or certainty associated with the face matching result. |
Updated 7 months ago