Banking

Everything an engine reads from a bank, a card issuer or a consumer-finance provider

View as Markdown

Where it lives: the whole family arrives in one object from the Financial Position endpoint, and each part of it is also served on its own. In a widget flow the same models travel inside the session results.

A banking extraction answers three questions about a person or a company at one institution: what they hold (accounts, cards, deposits, investments), what they owe (loans, mortgages, credit), and what moves (transactions and standing charges). It is the raw material for affordability, income verification, solvency and account-ownership checks — read from the institution itself rather than from a document somebody typed.

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

Reading any of these models

Every product in this family shares the same envelope, so once you can read one you can read all of them:

FieldWhat it is
idThe product’s identifier for this extraction. It is not stable across runs — match products by identifier (the IBAN, the masked card number) instead.
product · sub_familyWhat kind of thing this is. sub_family is the precise one — financial_card:credit, for instance — and it is what tells apart the variants that share an endpoint.
fetch_dateWhen this particular product was read.
product_name · product_alias · product_descriptionWhat the institution calls it, and what the customer renamed it to. Show the alias when there is one: it is the name the person recognises.
customer_segmentRetail or business, as the institution classifies the holder.
data_enrichmentWhether the record carries our enrichment on top of what the source published.

A missing product is not an empty product. If a feature was not requested, its key is absent from the global position and its endpoint answers 204. If it was requested and the customer has none, you get an empty list. The two mean very different things — see Reading the results.


The pages in this family