Scrub - Open API

​consent

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

Public bank-connection consent session (used by the hosted Link UI; no auth)

​Get consent session

GET
https://odoopi.usescrub.io
/c/{consent_token}/session

Public session lookup for the hosted Plaid Link UI. Always returns org branding (display_name, brand_name, logo_url) even when the link is expired, used, or invalid. Mounted at the app root (/c/...), not under /api/v1.

​Get consent session › path Parameters

  • consent_tokenstring · required

    Opaque token from CreateReportResponse.link_url

​Get consent session › Responses

    • statusstring · enum · required
      Enum values:
      valid
      expired
      used
      invalid
      Example: valid
    • display_namestring · required

      Name shown in Link UI — client brand_name, else client name, else Scrub

      Example: Acme Lending
    • brand_namestring
      Example: Acme Lending
    • logo_urlstring · uri
      Example: https://cdn.example.com/logo.png
    • applicant_namestring
      Example: Adebola James
    • detailstring

      Human-readable reason when status is not valid

      Example: Link expired

​Create Plaid link token

POST
https://odoopi.usescrub.io
/c/{consent_token}/link-token

Creates a provider link token for a valid consent session. Returns branding fields for the Link UI. Mounted at the app root (/c/...), not under /api/v1.

​Create Plaid link token › path Parameters

  • consent_tokenstring · required

​Create Plaid link token › Responses

    • link_tokenstring · required

      Provider link token for Plaid Link initialize

      Example: link-sandbox-xxxxxxxx
    • providerstring · required
      Example: plaid
    • brand_namestring
      Example: Acme Lending
    • logo_urlstring · uri
      Example: https://cdn.example.com/logo.png
    • display_namestring

      Resolved display name used as Plaid client_name

      Example: Acme Lending
reportverification