Run CRB score
Runs the CRB score check on one subject.
A credit reference bureau score for an individual.
The request below is this check's own payload: send it as-is, with your subject's details, and the result arrives at your webhook. One request can carry up to 500 reports, and can name other checks alongside this one.
See CRB score for what the check returns and how to read it.
Scope: reports:create
Creates and starts up to 500 reports in one request. Send the
reports array even for a single report.
This is where checks run: name the checks you want and Verifisha returns their results on the report.
Consent is yours to collect or ours. Set consent.mode. If your
own onboarding already has the subject's agreement, send
CUSTOMER_ATTESTED with your evidence and the checks run immediately —
Verifisha never contacts them. Send VERIFISHA_HOSTED only if you would
rather we asked. See the consent guide.
Payment. paymentMode decides who pays: your workspace (SELF),
the subject through a payment link (CANDIDATE_PAYS), or a nominated
payer (THIRD_PARTY_PAYS).
Retries. For a single-report request, send Idempotency-Key so a
network failure cannot create a second billable report.
Results. The report runs asynchronously. Subscribe to
report.ready; its payload carries
every check's outcome, risk and evidence.
Before you call this. Every check must accept the subject's
subjectType, and the subject must carry the details that check needs
— an individual credit check cannot run without idNumber, and
BRS_BUSINESS needs registrationNumber.
Use Authorization: Bearer vrf_live_... or vrf_test_....
In: header
Header Parameters
Optional idempotency key for single-report requests.
length <= 120Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/v1/reports" \ -H "Idempotency-Key: customer-case-1042" \ -H "Content-Type: application/json" \ -d '{ "reports": [ { "subject": { "fullName": "Jane Doe", "idNumber": "36901234", "email": "jane@example.com", "phone": "+254712345678", "country": "KE", "subjectType": "INDIVIDUAL" }, "checksRequested": [ "METROPOL_CRB_SCORE" ], "purpose": "Credit assessment", "consent": { "mode": "VERIFISHA_HOSTED" } } ] }'{ "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}