Scrub - Open API

​report

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

Financial reports via bank connection (Plaid)

​List financial reports

GET
https://odoopi.usescrub.io
/api/v1/report

List financial report cases for the authenticated client/user.

​List financial reports › query Parameters

  • limitinteger
  • offsetinteger

​List financial reports › Responses

    • itemsobject[]
    • totalinteger
    • limitinteger
    • offsetinteger

​Create financial report

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

Start a financial report case. Returns link_url for frontend embed (iframe/redirect). Applicant connects a bank via hosted Link; when done, Scrub POSTs report.ready or report.failed to your Controls webhook URL. Poll GET /report/{case_id} for status: PENDING_CONNECTION, CONNECTED, PROCESSING, REPORT_READY, FAILED, EXPIRED.

​Create financial report › Request Body

  • full_namestring · required
    Example: Adebola James
  • reference_idstring · required
    Example: loan_app_9981
  • contact_phonestring
    Example: +2348012345678
  • contact_emailstring · email
  • country_codesstring[]

    ISO 3166-1 alpha-2 country codes for Plaid Link

    Example: ["NG"]
    Default: ["US"]

​Create financial report › Responses

    • case_idstring · uuid
    • statusstring
      Example: PENDING_CONNECTION
    • messagestring
    • link_urlstring · uri

      Embed this URL in an iframe on the customer platform to open Plaid Link. The hosted UI calls GET /c/{token}/session then POST /c/{token}/link-token.

      Example: https://app.example.com/plaid/link?session=opaque-token

​Get financial report status

GET
https://odoopi.usescrub.io
/api/v1/report/{case_id}

Fetch case status. Statuses: PENDING_CONNECTION, CONNECTED, PROCESSING, REPORT_READY, FAILED, EXPIRED. When status is REPORT_READY, includes score, report payload, and optional PDF URL. Prefer webhooks (report.ready / report.failed) for async delivery.

​Get financial report status › path Parameters

  • case_idstring · uuid · required

​Get financial report status › Responses

    • case_idstring · uuid
    • reference_idstring
    • subject_idstring
    • statusstring · enum
      Enum values:
      PENDING_CONNECTION
      CONNECTED
      PROCESSING
      REPORT_READY
      FAILED
      EXPIRED
    • created_atstring · date-time
    • connection_completed_atstring · date-time
    • report_completed_atstring · date-time
    • webhook_delivered_atstring · date-time
    • reportobject
detectconsent