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.
Where this data arrives
The same models described here reach your systems through two doors, whichever API you integrate with:
- The results endpoints — fetch everything an extraction retrieved once it has finished.
- The webhooks — fired when an extraction completes (or delivers early results), carrying
the same data. If you provided an
aes_key, webhook payloads arrive encrypted — see Payload Encryption.
For the widget flow specifically, see the
Spain Public Administration API: its session results
endpoint and its partial/ended webhook events carry these models inside the session
envelope.
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.
The family map
Spain Public Administration results group every record by family — the same keys you
address in your code (data.customer.profile, data.employment.labor_check,
data.driver.vehicles…). Each page in this section covers one family of that map, and opens
by stating the exact path its data lives at:
The widget-flow session envelope
In the widget flow API, the family map above travels inside the session results envelope —
the same object the partial and ended webhooks deliver: