Skip to main content

BrightMatch Flow 2.0.0

· 2 min read
Macklin Hartley
Macklin Hartley
Principal Engineer

BrightMatch Flow 2.0.0 is a major update to the Flow schema, introducing a comprehensive member financial analysis alongside the existing application data.

New root structure​

The FlowOutput payload is now split into two top-level objects:

  • member — Member financial profile and open banking analysis data
  • application — Loan application form data submitted by the borrower

Member data (member)​

This is an entirely new section providing rich financial context derived from the member's connected accounts:

  • Profile — demographics, income summary, onboarding objectives, and employment info
  • Serviceability — detected and declared income/expenses, HEM and HPI benchmarks, housing floor calculations, guardrail results, and repayment capacity
  • Risk analysis — gambling, ATM withdrawal, and SACC loan risk metrics with flagged transaction streams
  • Streams — grouped transaction streams with BrightMatch categorisation, cadence detection, statistical summaries, and merchant identification
  • Accounts — all connected accounts with balance history, 90-day metrics, and Open Banking status
  • Transactions — individual transactions with provider and BrightMatch category classifications
  • Net capacity components — income and expense breakdown used for net capacity calculation
  • Identity — optional member identity verification (drivers licence or passport)
  • memberId — unique WeMoney member identifier

Application details (application)​

The application section has been updated with several structural changes from the previous version:

  • Employment — income fields (amount, isPreTax, frequency) are now flattened directly onto the employment object instead of nested under an income sub-object. The status field is renamed to type, and duration is replaced by startDate (YYYY-MM format).
  • Residence — duration is replaced by startDate (YYYY-MM format), and the state field is simplified (e.g. "NSW" instead of "AU-NSW").
  • Identity — the verificationType field is renamed to type with lowercase values ("passport", "driversLicense").
  • Loan & Expense amounts — amount fields are now typed as strings to match form submission values.
  • referenceId — new optional field for the external lender's reference ID.
  • Removed fields: applicationType, applicationId, userId, liabilities, otherIncome, previousEmployment, previousResidence.

New API endpoint​

Flow now includes an API for retrieving application data programmatically:

  • GET /flow/v1/applications/{applicationId} — returns the full FlowOutput for a given application
  • Authentication uses the same OAuth2 Client Credentials flow as Relay, with the flow/application:read scope

See the updated Flow documentation for the full schema reference.