Data models

The API reference shows you the endpoints; this section shows you the data — each model the platform can return, laid out flat so you never have to click through nested objects one by one to understand a payload.

Which product returns what

Each family on these pages is what a feature returns: ask an engine for accounts_read and the banking models are what comes back. The same models reach your systems whichever product you integrate with, and each product has its own overview of the ones it returns and of how they arrive:

How to read these pages

Each page covers one result: a short introduction — what the data is, where it comes from, what to use it for — followed by the model itself and its nested objects, each one flattened into its own expandable tree. The trees are rendered directly from the live API specification, so they can never drift from what the API actually returns.

Two family maps

Results are grouped by family, and there are two maps depending on what kind of source was read. Each page in this section covers one family, and opens by stating the exact path its data lives at.

Banks, card issuers and consumer finance

Accounts, cards, deposits, loans, investments and direct debits, under one object:

Public administrations

The keys you address in your code — data.customer.profile, data.employment.labor_check, data.driver.vehicles…

In both

The flows’ session envelope

In both flows, the family map travels as data inside the session results — the same object their webhooks deliver: