Peleza β€” Trust built on data
πŸ‡°πŸ‡ͺ Credit Bureau
On this page

Credit Reports

Kenya credit information reports (CIR) for individuals and businesses. Individual: POST /api/v1/credit-info/individual/ke with id_number. Business: POST /api/v1/credit-info/business/ke with registration_number. Both require consent: true. Providers: creditinfo (default) or metropol.

Loading sandbox test IDs…

Individual credit report

POST/api/v1/credit-info/individual/ke
{{baseUrl}}/api/v1/credit-info/individual/ke
HeaderTypeDescription
AuthorizationstringBearer YOUR_ACCESS_TOKEN from the OAuth client-credentials flow
Content-Typestringapplication/json

Body Parameters

ParameterTypeDescriptionRequired
id_numberstringKenyan national ID number (numeric, 6–10 digits) β€” individual endpointrequired
providerstringOptional bureau provider. Default "creditinfo". Allowed: creditinfo | metropoloptional
consentbooleanMust be true β€” confirms data-subject consent to perform this verificationrequired
customer_numberstringOptional reference for your own tracking (max 255 characters)optional

Individual request payload

Request payload for Individual request payload:

Sample dataRequest payload
{
  "provider": "creditinfo",
  "id_number": "12345678",
  "consent": true
}

Expected response for Individual request payload:

200 OKSample dataExpected response
{
  "success": true,
  "response_code": 200,
  "message": "Credit information retrieved successfully",
  "country": "ke",
  "data": {
    "provider": "creditinfo",
    "subject_type": "individual",
    "general": {
      "citizenship": "Kenyan",
      "country_of_birth": "KE",
      "creditinfo_id": "10000001",
      "date_of_birth": "1990-01-01T00:00:00Z",
      "education": null,
      "email": "john.doe.sample@example.com",
      "employer_name": "SAMPLE EMPLOYER LTD",
      "employment": "Employed",
      "forename1": "JOHN",
      "forename2": "SAMPLE",
      "full_name": "DOE JOHN SAMPLE",
      "gender": "Male",
      "home_phone": null,
      "income_available": {
        "currency": "KES",
        "value": "100000.00",
        "local_value": "100000.00"
      },
      "main_address": {
        "address_line": "123 SAMPLE STREET",
        "town": "Nairobi",
        "country": "KE",
        "postal_code": null
      },
      "marital_status": "Single",
      "mobile_phone": "254712345678",
      "national_id": "12345678",
      "reference_number": "CIR00001-10000001-10000001",
      "report_date": "2026-09-17T05:14:33.9612618Z",
      "report_reference_number": "10000001-10000001",
      "report_status": "ReportGenerated",
      "residency": null,
      "search_id_number": "12345678",
      "secondary_address": null,
      "social_status": null,
      "surname": "DOE",
      "vat_number": null,
      "work_phone": null
    },
    "scoring": {
      "cip_records": [
        {
          "date": "2026-09-17T05:14:32.2609304Z",
          "grade": "D3",
          "probability_of_default": "15.93",
          "reasons": [
            {
              "code": "MSS2",
              "description": "Delinquencies in no mobile contracts last 3 months"
            },
            {
              "code": "PDA1",
              "description": "Very high amount of past due contract last 6 months"
            }
          ],
          "score": "602.0",
          "trend": "Up"
        },
        {
          "date": "2026-08-30T21:00:00Z",
          "grade": "E3",
          "probability_of_default": "100.0",
          "reasons": [
            {
              "code": "BAD1",
              "description": null
            },
            {
              "code": "MSS2",
              "description": null
            }
          ],
          "score": "250.0",
          "trend": "NoChange"
        }
      ],
      "cip_risk_grade": "D3",
      "cip_score": "602.0",
      "probability_of_default": "15.93",
      "trend": "Up"
    },
    "contracts_summary": {
      "closed_contracts": 88,
      "open_contracts": 8,
      "original_amount_sum": 380336,
      "total_balance": 335751.53,
      "total_contracts": 96,
      "total_overdue_balance": 231185,
      "worst_days_in_arrears": 480,
      "worst_overdue_balance": {
        "currency": "KES",
        "local_value": "231185.00",
        "value": "231185.00"
      }
    },
    "contracts": [
      {
        "account_product_type": "MobileBankingLoan",
        "account_status": "GrantedAndActivated",
        "contract_code": "PL-10001",
        "currency_of_facility": "KES",
        "current_balance": null,
        "date_account_opened": "2026-03-15T21:00:00Z",
        "date_of_last_payment": null,
        "days_in_arrears": "0",
        "installment_amount": {
          "currency": "KES",
          "local_value": "3044.26",
          "value": "3044.26"
        },
        "installments_in_arrears": "0",
        "negative_status": "NoNegativeStatus",
        "original_amount": {
          "currency": "KES",
          "local_value": "3000.00",
          "value": "3000.00"
        },
        "outstanding_amount": {
          "currency": "KES",
          "local_value": "3000.00",
          "value": "3000.00"
        },
        "overdue_balance": {
          "currency": "KES",
          "local_value": "0.00",
          "value": "0.00"
        },
        "payment_frequency": "NotSpecified",
        "performing_indicator": "Normal",
        "phase_of_contract": "Open",
        "role_of_client": "MainDebtor",
        "sector": "Banks",
        "subscriber": "SAMPLE BANK LTD",
        "worst_past_due_amount": {
          "currency": "KES",
          "local_value": "0.00",
          "value": "0.00"
        },
        "worst_past_due_days": "0"
      }
    ],
    "payment_calendar": [
      {
        "contracts_submitted": "6",
        "current_balance": {
          "currency": "KES",
          "local_value": "64275.93",
          "value": "64275.93"
        },
        "date": "2026-09-29T21:00:00Z",
        "days_in_arrears": "0",
        "delinquency_status": "Ok",
        "installments_in_arrears": "1",
        "overdue_balance": {
          "currency": "KES",
          "local_value": "0.00",
          "value": "0.00"
        }
      }
    ],
    "dashboard": {
      "bounced_cheques": {
        "number_of_cheques": "0"
      },
      "cip": {
        "grade": "D3",
        "score": "602.0",
        "trend": "Up"
      },
      "credit_application": {
        "number_of_open": "0",
        "total_number": "0"
      },
      "disputes": {
        "active_contract_disputes": "0",
        "closed_contract_disputes": "0",
        "false_disputes": "0"
      },
      "inquiries": {
        "inquiries_for_last_12_months": "13",
        "subscribers_in_last_12_months": "1"
      },
      "payments_profile": {
        "closed_contracts": "88",
        "installment_amount_sum": {
          "currency": "KES",
          "local_value": "70565.98",
          "value": "70565.98"
        },
        "number_of_different_subscribers": "5",
        "open_contracts": "8",
        "past_due_amount_sum": {
          "currency": "KES",
          "local_value": "231185.00",
          "value": "231185.00"
        },
        "worst_past_due_days_current": "480",
        "worst_past_due_days_for_last_12_months": "480"
      }
    },
    "inquiries": {
      "number_of_inquiries_last_12_months": "13",
      "number_of_inquiries_last_1_month": "0",
      "number_of_inquiries_last_24_months": "14",
      "number_of_inquiries_last_3_months": "1",
      "number_of_inquiries_last_6_months": "1"
    },
    "disputes": {
      "active_disputes_contracts": "0",
      "active_disputes_in_court": "0",
      "closed_disputes_contracts": "0",
      "false_disputes": "0"
    },
    "credit_applications": {
      "applications": null,
      "number_of_closed_application": "0",
      "number_of_open_applications": "0",
      "total_number": "0",
      "total_number_12_months": "0"
    },
    "extract": {
      "consent": true,
      "consent_date": "2026-09-17T05:14:33.9612618Z",
      "application_date": "2026-09-17T05:14:33.9612618Z",
      "date_of_issue": "2026-09-17T05:14:33.9612618Z",
      "document_reference_no": "CIR00001-10000001-10000001",
      "full_names": "DOE JOHN SAMPLE",
      "document_no": "12345678",
      "document_type": "NationalID",
      "email_address": null
    },
    "parameters": {
      "id_number": "12345678",
      "id_number_type": "NationalID",
      "search_id_number": "12345678",
      "subject_type": "Individual",
      "inquiry_reason": "ApplicationForCreditOrAmendmentOfCreditTerms",
      "report_date": "2026-09-17T05:14:32.2609304Z",
      "consent": true
    }
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response Fields

FieldTypeDescription
successbooleanWhether the request succeeded
response_codenumberApplication response code (typically mirrors HTTP)
messagestringHuman-readable status message
dataobjectPayload for the verified resource
request_idstringUUID for support and audit trails
countrystringCountry code from the path (ke)
data.providerstringBureau used for this report (e.g. creditinfo)
data.subject_typestring"individual" or "business"
data.generalobjectSubject/company profile. Report-level subscriber is not returned.
data.scoringobjectCIP score, grade, PD, trend, and history records
data.contracts_summaryobjectOpen/closed counts and balance totals
data.contractsarrayFacility-level contract details
data.payment_calendararrayMonthly payment / delinquency calendar
data.dashboardobjectBureau dashboard snapshot
data.inquiriesobjectInquiry count summary
data.disputesobjectDispute count summary
data.credit_applicationsobjectCredit application summary counts
data.extractobjectConsent and document reference metadata
data.parametersobjectInquiry parameters echoed from the bureau

Providers

Optional provider field on both endpoints. Omit to use the default.

ProviderMeaning
creditinfoDefault. CreditInfo Kenya CIR.
metropolMetropol Kenya CIR.

Business credit report

POST /api/v1/credit-info/business/ke β€” company CIR by registration_number (BN / PVT / PLC / C / LLP). Requires consent: true. Billed as credit-info-business on HTTP 200 / 404.

POST/api/v1/credit-info/business/ke
{{baseUrl}}/api/v1/credit-info/business/ke

Business request payload

Sample dataRequest payload
{
  "provider": "creditinfo",
  "registration_number": "PVT-2019-123456",
  "consent": true
}
200 OKSample dataExpected response
{
  "success": true,
  "response_code": 200,
  "message": "Credit information retrieved successfully",
  "country": "ke",
  "data": {
    "provider": "creditinfo",
    "subject_type": "business",
    "general": {
      "company_income": {
        "currency": "KES",
        "local_value": "7808400.00",
        "value": "7808400.00"
      },
      "company_type": "LimitedLiabilityCompanyPrivate",
      "creditinfo_id": "20000002",
      "industry_code": "Trade",
      "main_address": {
        "address_line": "Nairobi CBD",
        "town": "Nairobi",
        "country": "KE",
        "postal_code": null
      },
      "main_telephone": "+254712345678",
      "other_telephone": null,
      "reference_number": "CIR00002-20000002-20000002",
      "registered_name": "SAMPLE HOLDINGS LIMITED",
      "registration_date": "1997-06-11T21:00:00Z",
      "registration_number": "C.12345",
      "report_date": "2026-09-16T08:48:52.9841439Z",
      "report_reference_number": "20000002-20000002",
      "report_status": "ReportGenerated",
      "search_registration_number": "PVT-2019-123456",
      "secondary_address": null,
      "trading_name": "SAMPLE HOLDINGS LIMITED",
      "trading_status": "Active",
      "vat_number": "P051000000A"
    },
    "scoring": {
      "cip_records": [
        {
          "date": "2026-09-16T08:48:51.1191238Z",
          "grade": "C3",
          "probability_of_default": "5.63",
          "reasons": [
            {
              "code": "MSS3",
              "description": "Delinquencies in no mobile contracts last 7 months"
            },
            {
              "code": "AGE2",
              "description": "Young age group"
            }
          ],
          "score": "652.0",
          "trend": "Up"
        },
        {
          "date": "2026-08-30T21:00:00Z",
          "grade": "C3",
          "probability_of_default": "6.84",
          "reasons": [
            {
              "code": "MSS3",
              "description": null
            },
            {
              "code": "AGE2",
              "description": null
            }
          ],
          "score": "643.0",
          "trend": "NoChange"
        }
      ],
      "cip_risk_grade": "C3",
      "cip_score": "652.0",
      "probability_of_default": "5.63",
      "trend": "Up"
    },
    "contracts_summary": {
      "closed_contracts": 8,
      "open_contracts": 3,
      "original_amount_sum": 47875833.58,
      "total_balance": 2154339.17,
      "total_contracts": 11,
      "total_overdue_balance": 10437.15,
      "worst_days_in_arrears": 12,
      "worst_overdue_balance": {
        "currency": "KES",
        "local_value": "17111.59",
        "value": "17111.59"
      }
    },
    "contracts": [
      {
        "account_product_type": "Overdraft",
        "account_status": "GrantedAndActivated",
        "contract_code": "OD-30001",
        "currency_of_facility": "KES",
        "current_balance": null,
        "date_account_opened": "2008-11-21T21:00:00Z",
        "date_of_last_payment": "2026-03-30T21:00:00Z",
        "days_in_arrears": "0",
        "installment_amount": {
          "currency": "KES",
          "local_value": "0.00",
          "value": "0.00"
        },
        "installments_in_arrears": "0",
        "negative_status": "NoNegativeStatus",
        "original_amount": {
          "currency": "KES",
          "local_value": "1008.68",
          "value": "1008.68"
        },
        "outstanding_amount": {
          "currency": "KES",
          "local_value": "1008.68",
          "value": "1008.68"
        },
        "overdue_balance": {
          "currency": "KES",
          "local_value": "10437.15",
          "value": "10437.15"
        },
        "payment_frequency": "Days30",
        "performing_indicator": "Normal",
        "phase_of_contract": "Open",
        "role_of_client": "MainDebtor",
        "sector": "Banks",
        "subscriber": "SAMPLE COMMERCIAL BANK",
        "worst_past_due_amount": {
          "currency": "KES",
          "local_value": "10437.15",
          "value": "10437.15"
        },
        "worst_past_due_days": "4"
      }
    ],
    "payment_calendar": [
      {
        "contracts_submitted": "1",
        "current_balance": {
          "currency": "KES",
          "local_value": "990335.12",
          "value": "990335.12"
        },
        "date": "2026-09-29T21:00:00Z",
        "days_in_arrears": "0",
        "delinquency_status": "Ok",
        "installments_in_arrears": "0",
        "overdue_balance": {
          "currency": "KES",
          "local_value": "0.00",
          "value": "0.00"
        }
      }
    ],
    "dashboard": {
      "bounced_cheques": {
        "number_of_cheques": "0"
      },
      "cip": {
        "grade": "C3",
        "score": "652.0",
        "trend": "Up"
      },
      "credit_application": {
        "number_of_open": "0",
        "total_number": "0"
      },
      "disputes": {
        "active_contract_disputes": "0",
        "closed_contract_disputes": "0",
        "false_disputes": "0"
      },
      "inquiries": {
        "inquiries_for_last_12_months": "0",
        "subscribers_in_last_12_months": "0"
      },
      "payments_profile": {
        "closed_contracts": "8",
        "installment_amount_sum": {
          "currency": "KES",
          "local_value": "1826137.00",
          "value": "1826137.00"
        },
        "number_of_different_subscribers": "3",
        "open_contracts": "3",
        "past_due_amount_sum": {
          "currency": "KES",
          "local_value": "10437.15",
          "value": "10437.15"
        },
        "worst_past_due_days_current": "0",
        "worst_past_due_days_for_last_12_months": "4"
      }
    },
    "inquiries": {
      "number_of_inquiries_last_12_months": "0",
      "number_of_inquiries_last_1_month": "0",
      "number_of_inquiries_last_24_months": "0",
      "number_of_inquiries_last_3_months": "0",
      "number_of_inquiries_last_6_months": "0"
    },
    "disputes": {
      "active_disputes_contracts": "0",
      "active_disputes_in_court": "0",
      "closed_disputes_contracts": "0",
      "false_disputes": "0"
    },
    "credit_applications": {
      "applications": null,
      "number_of_closed_application": "0",
      "number_of_open_applications": "0",
      "total_number": "0",
      "total_number_12_months": "0"
    },
    "extract": {
      "consent": true,
      "consent_date": "2026-09-16T08:48:52.9841439Z",
      "application_date": "2026-09-16T08:48:52.9841439Z",
      "date_of_issue": "2026-09-16T08:48:52.9841439Z",
      "document_reference_no": "CIR00002-20000002-20000002"
    },
    "parameters": {
      "id_number": "C.12345",
      "id_number_type": "RegistrationNumber",
      "search_id_number": "C.12345",
      "subject_type": "Company",
      "inquiry_reason": "ApplicationForCreditOrAmendmentOfCreditTerms",
      "report_date": "2026-09-16T08:48:51.1191238Z",
      "consent": true
    }
  },
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}
FieldTypeDescription
data.subject_typestringAlways "business"
data.general.registered_namestringRegistered company name
data.general.registration_numberstringRegistration number on the bureau file
data.general.search_registration_numberstringRegistration number you submitted
data.scoringobjectCIP score, grade, PD, trend, and history
data.contractsarrayFacility-level contract details
data.extractobjectConsent dates and document reference (no individual name fields)

Error codes

Standard Peleza HTTP / response_code values (same across all API calls). Validation message text is endpoint-specific. Full reference: Error Codes.

CodeWhenBilled?
200Credit report returned β€” billed as credit-info-individual or credit-info-businessYes
422Validation β€” missing/invalid fields, consent, or providerNo
401Missing or invalid Bearer tokenNo
402Insufficient wallet balance or credit limitNo
403No active wallet or billing profile (or service not enabled)No
404No credit information foundYes
404Unsupported country (not ke)No
429Rate limitedNo
503Credit information service unavailable / timeoutNo

Set {{baseUrl}} to https://api.peleza.com (production) or https://sandbox.peleza.com (sandbox). Authenticated calls need a Bearer token from POST /api/v1/oauth/token.