Scrub - Open API

​credit

Endpoint:https://odoopi.usescrub.io/v1

Credit scoring, reporting, and bureau inquiry for Nigerian consumers

​Get credit score

POST
https://odoopi.usescrub.io/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.

​Get credit score › Request Body

  • bvnstring · required
    Example: 22345678901
  • consent_referencestring · required

    Reference to stored customer consent

    Example: cns_abc123
  • bureaustring · enum
    Enum values:
    crc
    firstcentral
    all
    Default: all

​Get credit score › Responses

    • bvnstring
    • scoreinteger

      300–850 scale

      Example: 682
    • ratingstring · enum
      Enum values:
      excellent
      good
      fair
      poor
      very_poor
      Example: good
    • bureau_sourcestring
      Example: crc
    • factorsobject[]
    • request_idstring

​Generate credit report

POST
https://odoopi.usescrub.io/v1
/credit/report/

Generates a comprehensive credit report including score, active loans, repayment history, and delinquencies. Reports are available for retrieval for 30 days.

​Generate credit report › Headers

  • Idempotency-Keystring

​Generate credit report › Request Body

  • bvnstring · required
    Example: 22345678901
  • consent_referencestring · required
    Example: cns_abc123
  • include_loansboolean
    Default:
  • include_inquiriesboolean
    Default:

​Generate credit report › Responses

    • report_idstring
      Example: crp_8f3k2m9x
    • statusstring · enum
      Enum values:
      pending
      processing
      Example: processing
    • estimated_ready_atstring · date-time
    • request_idstring

​Retrieve credit report

GET
https://odoopi.usescrub.io/v1
/credit/report/{report_id}/

Fetches a previously generated credit report by ID. Poll this endpoint after receiving a credit.report.ready webhook event.

​Retrieve credit report › path Parameters

  • report_idstring · required

    Report ID returned from POST /credit/report/

​Retrieve credit report › Responses

    • report_idstring
    • bvnstring
    • scoreinteger
      Example: 682
    • ratingstring
      Example: good
    • generated_atstring · date-time
    • active_loansobject[]
    • inquiries_last_12minteger
      Example: 3
    • delinquenciesinteger

​Submit credit inquiry

POST
https://odoopi.usescrub.io/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.

​Submit credit inquiry › Request Body

  • bvnstring · required
    Example: 22345678901
  • inquiry_typestring · enum · required
    Enum values:
    soft
    hard
    Example: soft
  • consent_referencestring · required
    Example: cns_abc123
  • purposestring · enum · required
    Enum values:
    loan_application
    account_opening
    periodic_review
    Example: loan_application

​Submit credit inquiry › Responses

    • inquiry_idstring
      Example: inq_7k2m9x
    • inquiry_typestring
      Example: soft
    • recorded_on_bureauboolean
    • score_at_inquiryinteger
      Example: 682
    • request_idstring

​Get repayment history

GET
https://odoopi.usescrub.io/v1
/credit/history/

Returns summarized loan and repayment history for a consumer, including active facilities, closed accounts, and delinquency flags.

​Get repayment history › query Parameters

  • bvnstring · required

    11-digit BVN

  • monthsinteger

    Lookback period in months (max 60)

​Get repayment history › Responses

    • bvnstring
    • months_analyzedinteger
      Example: 24
    • total_facilitiesinteger
      Example: 4
    • active_facilitiesinteger
      Example: 2
    • on_time_payments_pctnumber
      Example: 94.5
    • worst_delinquency_daysinteger
    • facilitiesobject[]
    • request_idstring
fraudOther endpoints