Credit scoring and bureau inquiry for Nigerian consumers
Get credit score
POST
https://odoopi.usescrub.io
/api/v1/credit/score/
Retrieves a consumer credit score (300–850) based on repayment history, credit utilization, and bureau data from CRC Credit Bureau and FirstCentral. Requires explicit customer consent.
Request Body
bvnstring · requiredExample: 22345678901consent_referencestring · requiredReference to stored customer consent
Example: cns_abc123
bureaustring · enumEnum values:crcfirstcentralallDefault: all
Responses
bvnstringscoreinteger300–850 scale
Example: 682ratingstring · enumEnum values:excellentgoodfairpoorvery_poorExample: goodbureau_sourcestringExample: crcfactorsobject[]request_idstring
Submit credit inquiry
POST
https://odoopi.usescrub.io
/api/v1/credit/inquiry/
Submits a soft or hard credit inquiry to Nigerian credit bureaus. Soft inquiries do not affect the consumer's score; hard inquiries are recorded on the bureau file.
Request Body
bvnstring · requiredExample: 22345678901inquiry_typestring · enum · requiredEnum values:softhardExample: softconsent_referencestring · requiredExample: cns_abc123purposestring · enum · requiredEnum values:loan_applicationaccount_openingperiodic_reviewExample: loan_application
Responses
inquiry_idstringExample: inq_7k2m9xinquiry_typestringExample: softrecorded_on_bureaubooleanscore_at_inquiryintegerExample: 682request_idstring
Get repayment history
GET
https://odoopi.usescrub.io
/api/v1/credit/history/
Returns summarized loan and repayment history for a consumer, including active facilities, closed accounts, and delinquency flags.
query Parameters
bvnstring · required11-digit BVN
monthsintegerLookback period in months (max 60)
Responses
bvnstringmonths_analyzedintegerExample: 24total_facilitiesintegerExample: 4active_facilitiesintegerExample: 2on_time_payments_pctnumberExample: 94.5worst_delinquency_daysintegerfacilitiesobject[]request_idstring