Credit Reference Bureau

The Kenya Credit Reference Bureau (CRB) endpoint authorize users, such as banks, microfinance institutions, and other credit providers, to access an individual's credit history and repayment behavior.

By accessing the Kenya CRB endpoint, lenders can make more informed lending decisions, assess creditworthiness, and manage risk effectively. This plays a pivotal role in promoting responsible lending practices, enhancing transparency in the credit ecosystem, and fostering a healthy and stable financial environment in Kenya.

πŸ‘

TEST DATA

first_name: john

last_name: doe

national_id: 12345678

πŸ“˜

POST

{{URL}}/identitypass/verification/ke/crb

Request Header

KeyDescription
x-api-keyYour Secret Key
app-idYour app id

Request Body

KeyDescription
first_nameFirst name of the customer
last_nameLast name of the customer
national_idNational Identity number of the customer

Sample Response

{
    "status": true,
    "response_code": "00",
    "data": {
        "summary": {
            "pa_open_mobi_loan_accounts": 3,
            "npa_closed_accounts": 1,
            "npa_open_accounts": 1,
            "pa_closed_accounts": 11,
            "pa_accounts_with_dh": 1,
            "last_mobi_loan_listing_date_my_sector": "14-09-2018",
            "pa_accounts": 17,
            "pa_closed_mobi_loan_accounts": 11,
            "mobi_loan_accounts": 15,
            "enquiries31_to60_days": 0,
            "bounced_cheques": 0,
            "min_mobi_loan_principal_amount": 6150,
            "avg_mobi_loan_principal_amount": 8608.33,
            "last_mobi_loan_listing_date_other_sectors": "13-07-2019",
            "legal_suits": 0,
            "npa_closed_mobi_loan_accounts": 0,
            "mobi_loans_score": "581",
            "pa_open_mobi_loan_accounts_with_dh": 0,
            "fraudulent_cases": 0,
            "pa_open_accounts_with_dh": 0,
            "pa_closed_mobi_loan_accounts_with_dh": 1,
            "npa_open_mobi_loan_accounts": 1,
            "last_mobi_loan_principal_amount": 35000,
            "credit_history": 45,
            "enquiries_last30_days": 0,
            "max_mobi_loan_principal_amount": 35000,
            "credit_applications": 0,
            "pa_open_accounts": 6,
            "enquiries61_to90_days": 0,
            "npa_accounts": 1,
            "enquiries91_days": 0,
            "pa_closed_accounts_with_dh": 0
        },
        "phone_numbers": [
            {
                "phone_number": "254000000000",
                "phone_type": "LANDLINE"
            }
        ],
        "product": "PRODUCT131",
        "personal_profile": {
            "national_id": "12345678",
            "full_name": "JOHN DOE",
            "gender": "",
            "surname": "JOHN",
            "date_of_birth": "01-01-1990",
            "transunion_log": null,
            "other_names": "DOE"
        },
        "score_output": {
            "reason_code_aarc1": "Low number of payments recently",
            "reason_code_aarc2": "Satisfactory accounts are relatively old",
            "reason_code_aarc3": "Recent delinquency on accounts",
            "reason_code_aarc4": "Average credit limit of Revolving accounts are relatively low",
            "probability": "23.96",
            "grade": "EE",
            "positive_score": null,
            "mobi_loans_score": "581"
        }
    },
    "verification": {
        "reference": "bb3ad76a-b618-4540-a944-48195e26f5a1"
    },
    "session": {}
}

Response Description

ResponseDescription
statusIndicates the status of the response.
response_codeRepresents the response code associated with the request.
dataThis section contains various data related to the profile or summary.
summaryThis section contains summarized information about the data.
pa_open_mobi_loan_accountsNumber of open mobile loan accounts that are performing well.
npa_closed_accountsNumber of closed accounts that were non-performing assets.
npa_open_accountsNumber of open accounts that are non-performing assets.
pa_closed_accountsNumber of closed accounts that are performing well.
pa_accounts_with_dhNumber of accounts with credit deficiencies that are performing well.
last_mobi_loan_listing_date_my_sectorDate of the last listing of a mobile loan in the sector.
pa_accountsTotal number of accounts that are performing well.
pa_closed_mobi_loan_accountsNumber of closed mobile loan accounts that are performing well.
mobi_loan_accountsTotal number of mobile loan accounts.
enquiries31_to60_daysNumber of credit inquiries made within 31 to 60 days.
bounced_chequesNumber of bounced cheques.
min_mobi_loan_principal_amountMinimum principal amount of mobile loans.
avg_mobi_loan_principal_amountAverage principal amount of mobile loans.
last_mobi_loan_listing_date_other_sectorsDate of the last listing of a mobile loan in other sectors.
legal_suitsNumber of legal suits.
npa_closed_mobi_loan_accountsNumber of closed mobile loan accounts that were non-performing assets.
mobi_loans_scoreThe score associated with the mobile loans.
pa_open_mobi_loan_accounts_with_dhNumber of open mobile loan accounts with credit deficiencies that are performing well.
fraudulent_casesNumber of fraudulent cases.
pa_open_accounts_with_dhNumber of open accounts with credit deficiencies that are performing well.
pa_closed_mobi_loan_accounts_with_dhNumber of closed mobile loan accounts with credit deficiencies that are performing well.
npa_open_mobi_loan_accountsNumber of open mobile loan accounts that are non-performing assets.
last_mobi_loan_principal_amountThe principal amount of the last mobile loan.
credit_historyThe credit history duration in months.
enquiries_last30_daysNumber of credit inquiries made within the last 30 days.
max_mobi_loan_principal_amountMaximum principal amount of mobile loans.
credit_applicationsNumber of credit applications.
pa_open_accountsNumber of open accounts that are performing well.
enquiries61_to90_daysNumber of credit inquiries made within 61 to 90 days.
npa_accountsNumber of accounts that are non-performing assets.
enquiries91_daysNumber of credit inquiries made within 91 days or more.
pa_closed_accounts_with_dhNumber of closed accounts with credit deficiencies that are performing well.
phone_numbersInformation related to phone numbers associated with the person.
phone_numberThe phone number.
phone_typeThe type of phone number.
productThe product associated with the data.
personal_profilePersonal profile information about an individual.
national_idThe national identification number.
full_nameThe full name of the individual.
genderThe gender of the individual.
surnameThe last name or surname of the individual.
date_of_birthThe date of birth of the individual.
transunion_logLog information related to TransUnion data.
other_namesOther names or middle names of the individual.
score_outputInformation related to the score output.
reason_code_aarc1Reason code indicating a low number of payments recently.
reason_code_aarc2Reason code indicating satisfactory accounts are relatively old.
reason_code_aarc3Reason code indicating recent delinquency on accounts.
reason_code_aarc4Reason code indicating average credit limit of revolving accounts is relatively low.
probabilityProbability associated with the score output.
gradeGrade associated with the score output.
positive_scorePositive score information.
mobi_loans_scoreThe score associated with the mobile loans.
verificationInformation related to verification.
referenceUnique reference code associated with the verification.
sessionSession-related information.