Skip to navigation

Data models

What a direct execution returns, field by field
View as Markdown

A direct execution runs one engine against one source, and what it returns depends on the kind of source: a bank, a card issuer or a consumer-finance provider returns a financial position; a public administration returns a public position. Both carry the customer profile, and one family per feature you asked for. A family you did not ask for is absent. These pages lay each model out flat, field by field, rendered from the live API specification.

Where the data arrives

Results are pulled, never pushed: a direct execution’s webhooks say that it finished, never what it found. Once it closes, its records wait behind your application secret, addressed by execution_id:

  • The whole position in one call — Financial Position or Public Position. The one we recommend.
  • One family at a time — each family has its own endpoint, for when you need one thing only or want it the moment its feature closes.

Reading the results walks through both, and through deleting them when you are done.

The financial position

From banks, card issuers and consumer-finance providers:

customerobjectOptional
Customer family
accountslist of objectsOptional
Current accounts
cardslist of objectsOptional
Cards
depositslist of objectsOptional
Deposits
investmentsobjectOptional
Investments family
loanslist of objectsOptional
Loans
direct_debitslist of objectsOptional
Direct debits

The public position

From the Spanish public administrations:

customerobjectOptional
Customer family
academicobjectOptional
Academic family
driverobjectOptional

Driver & vehicles family

employmentobjectOptional
Employment family
taxobjectOptional
Tax family
propertiesobjectOptional
Properties family
creditobjectOptional
Credit registry family

In both

Invoices from a utility, a telecom or a supplier portal are served under /commercial/v1/, received and issued separately; the API reference carries their schema beside each endpoint.