Skip to main content

API reference

Use API reference when you need endpoint-level detail (paths, schemas, headers, error codes). For implementation steps and customer flows, use the product guides.

Choose a reference​

AU CDRNZ PNZ

Data Recipient API

Endpoints for data provider discovery, connection lifecycle, and data retrieval via Wych.

  • Data holders and metadata
  • Connections and consent lifecycle
  • Accounts, balances, transactions

Open Recipient spec

Go to Recipient guides

AU CDR

Compliance Validation API

Endpoints for initiating tests, retrieving results, and exporting evidence for Data Holder validation.

  • Test targets and configuration
  • Test runs and result retrieval
  • Evidence and reporting outputs

Open Validation spec

Go to Validation guides

AU CDRNZ PNZ

Data Holder API

Data Holder endpoints and authorisation flows for serving customer-consented data to third parties.

  • Brand and metadata endpoints
  • Consent and authorisation behaviour
  • Accounts and transactions endpoints

Open Holder spec

Go to Holder guides

Reference versus guides​

  • Use Guides for implementation sequence and customer journeys.
  • Use API reference for endpoint behaviour, schema detail, and troubleshooting.