Creditinfo Report
# Request Parameters
The following parameters are expected:
| Field | Description | Type |
|---|---|---|
| search_type | The Search type you want to do. Examples: CREDITINFO | String |
| document_type | The identity document you will use to query.Examples: NationalID | String |
| client_name | The client sname whose CRB you want to query. Examples: John Doe | String |
| identifier | This is the search parameter. E.g. ID Number | String |
| consent | Indicates whether the data owner has consented to identity verification 1 if yes 0 if no.1 if yes 0 if no. | Boolean |
| consent_collected_by | Name of the person giving consent. Examples: Jane Doe | String |
Please find sample implementation on the left
# Response Parameters
Below is a sample response
# Creditinfo Search
'search_type' is
CREDITINFOandidentifieris the client's ID Number
Search details on a customer's creditinfo using their ID Number. As sample response is as follows:
{
"code": "200.001",
"data": {
"Data": {
"response": {
"status": "ok",
"infomsg": "ReportGenerated",
"Currency": "KES",
"ScoringAnalysis": {
"MobileScore": "601",
"MobileScoreRiskGrade": "D1"
},
"KenCb5_data": {
"BouncedCheques": null,
"CIP": {
"RecordList": {
"Record": [
{
"Date": "2026-01-30T14:13:28.706029Z",
"Grade": "E3",
"ProbabilityOfDefault": "100",
"ReasonsList": {
"Reason": [
{
"Code": "BAD1",
"Description": "Current bad payment behaviour"
},
{
"Code": "MSS1",
"Description": "Serious delinquencies last 3 months"
},
{
"Code": "NSI1",
"Description": "1 or more missed payments last 2 months"
},
{
"Code": "NCO1",
"Description": "3 or more non-mobile contracts were started last 9 months"
},
{
"Code": "DPM1",
"Description": "Very high number of days past due on mobile contract last 6 months"
}
]
},
"Score": "250",
"Trend": "NoChange"
}
]
}
},
"CIQ": {
"Detail": {
"LostStolenRecordsFound": "0",
"NumberOfCancelledClosedContracts": "0"
},
"Summary": {
"NumberOfFraudAlertsPrimarySubject": "0",
"NumberOfFraudAlertsThirdParty": "0"
}
},
"ContractOverview": {
"ContractList": {
"Contract": [
{
"AccountProductType": "MobileBankingLoan",
"AccountStatus": "WithArrearsNoRepossession",
"CurrentBalance": {
"Currency": "KES",
"LocalValue": "2300.00",
"Value": "2300.00"
},
"DateAccountOpened": "2021-12-13T21:00:00Z",
"DaysInArrears": "90",
"OriginalAmount": {
"Currency": "KES",
"LocalValue": "2000.00",
"Value": "2000.00"
},
"OverdueBalance": {
"Currency": "KES",
"LocalValue": "2300.00",
"Value": "2300.00"
},
"PerformingIndicator": "NotSpecified",
"PhaseOfContract": "Open",
"RoleOfClient": "MainDebtor",
"Sector": "MFIDonor"
}
]
}
},
"ContractSummary": {
"Debtor": {
"ClosedContracts": "44",
"CurrentBalanceSum": {
"Currency": "KES",
"LocalValue": "4872.95",
"Value": "4872.95"
},
"OpenContracts": "2",
"OriginalAmountSum": {
"Currency": "KES",
"LocalValue": "4000.00",
"Value": "4000.00"
},
"OverdueBalanceSum": {
"Currency": "KES",
"LocalValue": "4872.95",
"Value": "4872.95"
}
},
"Overall": {
"LastDelinquency90PlusDays": "2025-12-16T21:00:00Z",
"WorstDaysInArrears": "1047",
"WorstOverdueBalance": {
"Currency": "KES",
"LocalValue": "5611.76",
"Value": "5611.76"
}
}
},
"Contracts": {
"ContractList": {
"Contract": [
{
"AccountProductType": "MobileBankingLoan",
"AccountStatus": "WithArrearsNoRepossession",
"ContractCode": "23******83",
"DateAccountOpened": "2021-12-13T21:00:00Z",
"DaysInArrears": "90",
"InstallmentAmount": {
"Currency": "KES",
"LocalValue": "2300.00",
"Value": "2300.00"
},
"InstallmentsInArrears": "4",
"NegativeStatusOfContract": "Collection",
"OriginalAmount": {
"Currency": "KES",
"LocalValue": "2000.00",
"Value": "2000.00"
},
"OutstandingAmount": {
"Currency": "KES",
"LocalValue": "2300.00",
"Value": "2300.00"
},
"OverdueBalance": {
"Currency": "KES",
"LocalValue": "2300.00",
"Value": "2300.00"
},
"PhaseOfContract": "Open",
"RoleOfClient": "MainDebtor",
"Subscriber": "Branch Microfinance Bank Limited",
"SubscriberType": "MFIDonor"
}
]
}
}
}
}
}
}
}