Verification ChecksFinancial & credit

Summary CRB report

A short credit reference bureau summary.

Send METROPOL_SUMMARY_CRB_REPORT in checksRequested to run this check.

The request

POST /api/v1/reports
{
  "subject": {
    "fullName": "Jane Doe",
    "idNumber": "36901234",
    "email": "jane@example.com",
    "phone": "+254712345678",
    "country": "KE",
    "subjectType": "INDIVIDUAL"
  },
  "checksRequested": [
    "METROPOL_SUMMARY_CRB_REPORT"
  ],
  "purpose": "Credit assessment",
  "consent": {
    "mode": "VERIFISHA_HOSTED"
  }
}

The acknowledgement

Creation is asynchronous. The report comes back as a draft; the check runs after.

201 Created
{
  "reports": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "DRAFT",
      "paymentState": {
        "status": "NOT_REQUIRED",
        "amount": {
          "amount": 0.1,
          "currency": "KES"
        }
      },
      "consentState": {
        "status": "NOT_REQUIRED"
      }
    }
  ],
  "count": 1
}

The result

When the check finishes, this arrives at your webhook. COMPLETED means it ran — read riskLevel and flags to decide what it found.

On this page