/v3/crb
credit:read
Credit Reference Bureau
Pull a credit-bureau report for an individual or a business.
Try it
Sandbox returns deterministic mock data, no wallet charge. Checking Live availability…
Request body
Body parameters
| Field | Type | Description |
|---|---|---|
national_idrequired |
string | National ID (individual) or registration number (business). |
subject_type |
string | INDIVIDUAL | BUSINESS. |
Example responses
200 · Result
{
"request_id": "req_8f2c1a9b7d3e4f60",
"ok": true,
"data": {
"score": 712,
"band": "GOOD",
"open_accounts": 3,
"adverse_records": 0,
"enquiries_6m": 1
}
}
400 · Bad request
{
"error": "invalid_request",
"message": "national_id is required"
}
401 · Unauthorized
{
"error": "unauthorized",
"message": "API credentials required. Send Authorization: Bearer <client_id>:<secret>."
}
Runs use your signed-in session. For system-to-system integration, issue a keypair in the
Console and send
Authorization: Bearer <client_id>:<secret> against
https://credit.farmsky.africa (Sandbox https://sandbox.credit.farmsky.africa).