Verification ChecksFinancial & credit
Credit bureau status
Whether an individual is listed or clear at the credit bureau.
Send CREDITINFO_CRB_STATUS in checksRequested to run this check.
CREDITINFO_CRB_STATUS is accepted as an alias of CREDITINFO_STATUS.
The request
{
"subject": {
"fullName": "Jane Doe",
"idNumber": "36901234",
"email": "jane@example.com",
"phone": "+254712345678",
"country": "KE",
"subjectType": "INDIVIDUAL"
},
"checksRequested": [
"CREDITINFO_CRB_STATUS"
],
"purpose": "Credit assessment",
"consent": {
"mode": "VERIFISHA_HOSTED"
}
}The acknowledgement
Creation is asynchronous. The report comes back as a draft; the check runs after.
{
"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.
Related
- Run a Verification — this check's endpoints, with a playground
- Webhooks — the delivery, its headers and signature
- Statuses and outcomes — what the result means
GET /checks/definitions— price, inputs and availability for your workspace