> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://infonite.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://infonite.dev/_mcp/server. # Banking **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. ### Schema (`FinancialGlobalPositionSchema`) ```yaml components: schemas: CustomerType: type: string enum: - person - company - unknown title: CustomerType IdentificationNumberSchemaType: type: string enum: - unknown - es:dni - es:nie - es:cif - es:ssn - co:cc - co:ce - co:nit - co:ti description: >- Kind of document the number belongs to (e.g. a national ID, passport, tax ID, or Social Security number). title: IdentificationNumberSchemaType IdentificationNumberSchema: type: object properties: type: $ref: '#/components/schemas/IdentificationNumberSchemaType' description: >- Kind of document the number belongs to (e.g. a national ID, passport, tax ID, or Social Security number). value: type: string description: The number itself, as reported by the source. validated: type: boolean description: >- True when the value passed the platform's format and check-digit validation. It vouches for the NUMBER being well-formed — not for the official status of the document behind it. country: type: - string - 'null' format: country description: Country that issued the number, as a two-letter ISO code. valid_until: type: string format: date description: Expiry date of the document, when the source reports it. required: - type - value - validated description: >- One identification document: its type, its value, and whether the value passed validation. title: IdentificationNumberSchema PersonGender: type: string enum: - male - female - rather_not_say - unknown title: PersonGender CivilStatus: type: string enum: - single - married - divorced - widowed - separated - unknown title: CivilStatus AddressSchema: type: object properties: title: type: - string - 'null' description: Free label for the address (e.g. `Headquarter`, `Domicilio`). street: type: - string - 'null' description: 'Street line: name and number.' street_extra: type: - string - 'null' description: 'Second street line: floor, suite, staircase, apartment...' municipality: type: - string - 'null' description: Municipality the address belongs to. city: type: - string - 'null' description: City or town. state: type: - string - 'null' description: State or province code. country: type: - string - 'null' format: country description: Country, as a two-letter ISO code. zip_code: type: - string - 'null' description: Postal code. description: >- A postal address. It is reused wherever the platform reports one — a person's home, a company's registered office, a property's location — so these fields describe the address itself; what it belongs to is told by the object carrying it. title: AddressSchema CustomerProfileSchema: type: object properties: product: type: string enum: - customer_information description: >- The product type identifier. Always `customer_information` for this product. sub_family: type: string enum: - customer_information:user_profile description: >- The sub-family identifier: `customer_information:user_profile`, the customer's profile at the institution. fetch_date: type: string format: datetime description: Date this information was fetched. type: $ref: '#/components/schemas/CustomerType' description: >- The kind of customer: a person or a company. This is the switch that tells you how to read the rest of the profile. name: type: string description: >- For persons, the given name(s); for companies, the registered legal name (razón social). name_extra: type: string description: >- **Persons only** — the rest of the legal name; Spanish institutions report both surnames here. Empty for companies. alias: type: string description: >- How the institution addresses the customer when it differs from the legal name — a chosen or commercial name. identification_numbers: type: array items: $ref: '#/components/schemas/IdentificationNumberSchema' description: >- The customer's identification documents as the institution registers them — for persons a DNI/NIE, passport or Social Security number; for companies the tax ID (CIF). Each entry carries its type, its value, and whether the value passed validation. birth_date: type: string format: date description: >- For persons, the date of birth; for companies, the date of incorporation, when the source provides it. birth_country: type: string format: country description: Country of birth, as a two-letter ISO code. nationality_country: type: string format: country description: >- For persons, the country of nationality; for companies, the country of the registered seat. Two-letter ISO code. residence_country: type: string format: country description: >- For persons, the country of residence; for companies, the country of its tax residence. Two-letter ISO code. gender: $ref: '#/components/schemas/PersonGender' description: >- **Persons only** — gender as declared at the institution. `unknown` for companies, and for persons whose source does not disclose it. civil_status: $ref: '#/components/schemas/CivilStatus' description: >- **Persons only** — civil status as declared at the institution. `unknown` for companies, and for persons whose source does not disclose it. number_of_children: type: integer description: >- **Persons only** — number of children, when the institution records it. Empty for companies. emails: type: array items: type: string description: Email addresses of the customer, as they appear at the source. phones: type: array items: type: string description: Phone numbers of the customer, as they appear at the source. addresses: type: array items: $ref: '#/components/schemas/AddressSchema' description: Postal addresses of the customer, as they appear at the source. language: type: string format: language description: The customer's preferred language, as an ISO language code. member_since: type: string format: date description: >- Date the customer's relationship with the institution began, when the source reports it. required: - product - sub_family - fetch_date - type - identification_numbers - gender - civil_status - emails - phones - addresses description: >- The customer's identity as the connected institution knows it: names, identification documents, birth and nationality, contact details (emails, phones, addresses) and declared situation (civil status, children, membership age). Use it to verify identity and to cross-check data the user typed against what their institution knows about them. **One profile describes both persons and companies** — `type` tells you which one you are reading. Some fields switch meaning accordingly (`name`, `birth_date`, `nationality_country`, `residence_country` — each one says how); the strictly person-only fields behave predictably for companies: `name_extra` and `number_of_children` come empty, and `gender` / `civil_status` come as `unknown`. title: CustomerProfileSchema CustomerFamily: type: object properties: profile: $ref: '#/components/schemas/CustomerProfileSchema' description: Customer profile title: CustomerFamily CurrentAccountSchemaDataEnrichment: type: string enum: - skipped - pending - processing - ready - failed description: >- Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data. title: CurrentAccountSchemaDataEnrichment CurrentAccountSchemaIdentifier: oneOf: - type: object properties: type: type: string enum: - clabe description: 'Discriminator value: clabe' value: type: string format: clabe description: Clave Bancaria Estandarizada masked: type: string minLength: 1 maxLength: 19 description: Partial Clabe entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digit required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: Clave Bancaria Estandarizada - type: object properties: type: type: string enum: - generic description: 'Discriminator value: generic' value: type: string description: Identifier entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code entity_office: type: string description: Entity office control_digits: type: string description: Control digits required: - type - value description: Generic account identifier - type: object properties: type: type: string enum: - iban description: 'Discriminator value: iban' value: type: string format: iban description: International Bank Account Number masked: type: string minLength: 1 maxLength: 34 description: Partial IBAN entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digits required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: International Bank Account Number discriminator: propertyName: type description: Account identifier title: CurrentAccountSchemaIdentifier CustomerSegment: type: string enum: - not_assigned - personal - business - corporate - private - retail title: CustomerSegment InfoniteSchemasUtilsCurrencyAmountSchema1Currency: oneOf: - type: string format: currency - type: string enum: - '***' description: >- Three-letter ISO currency code — or `***` when the source did not disclose the currency. title: InfoniteSchemasUtilsCurrencyAmountSchema1Currency infonite__schemas__utils__CurrencyAmountSchema__1: type: object properties: currency: $ref: >- #/components/schemas/InfoniteSchemasUtilsCurrencyAmountSchema1Currency description: >- Three-letter ISO currency code — or `***` when the source did not disclose the currency. amount: type: string format: number description: Decimal number with 2 digits precision required: - currency - amount description: A monetary amount together with its currency. title: infonite__schemas__utils__CurrencyAmountSchema__1 FinancialTransactionType: type: string enum: - unknown - opening - closure - credit - debit - default title: FinancialTransactionType FinancialTransactionStatus: type: string enum: - unknown - pending - booked - cancelled - failed - reversed title: FinancialTransactionStatus FinancialTransactionCategory: type: string enum: - expenses::to categorize::unclassified - expenses::household::other household - expenses::household::rent - expenses::household::mortgage - expenses::household::utilities - expenses::household::communications - expenses::household::insurance & fees - expenses::household::services - expenses::home improvement::other home improvement - expenses::home improvement::renovation & repairs - expenses::home improvement::furniture & interior - expenses::home improvement::garden & outdoor - expenses::food & drinks::other food & drinks - expenses::food & drinks::groceries & supermarket - expenses::food & drinks::dining out - expenses::food & drinks::coffee & snacks - expenses::food & drinks::alcohol & tobacco - expenses::transport::other transport - expenses::transport::car & fuel - expenses::transport::public transport - expenses::transport::flights - expenses::transport::taxi & ride-share - expenses::shopping::other shopping - expenses::shopping::clothes & accessories - expenses::shopping::electronics & gadgets - expenses::shopping::hobby & sports equipment - expenses::shopping::books & games - expenses::shopping::gifts - expenses::leisure & entertainment::other leisure & entertainment - expenses::leisure & entertainment::culture events - expenses::leisure & entertainment::hobbies, sports & fitness - expenses::leisure & entertainment::hotels & vacation - expenses::leisure & entertainment::lottery & betting - expenses::health & beauty::other health & beauty - expenses::health & beauty::pharmacy - expenses::health & beauty::medical - expenses::health & beauty::beauty & personal care - expenses::health & beauty::optician & dentist - expenses::financial & organizations::other financial expenses - expenses::financial & organizations::credit obligations - expenses::financial & organizations::fees & charges - expenses::financial & organizations::public dues - expenses::other::other expenses - expenses::other::education - expenses::other::charity - expenses::other::associations - expenses::other::pets - expenses::other::kids - expenses::other::cash withdrawals - expenses::other::transfers - expenses::other::family pension/alimony - income::to categorize::unclassified - income::income::other income - income::income::salary & payroll - income::income::passive income - income::income::pension - income::income::subsidies & grants - income::income::tax refunds - income::income::transfers - income::income::cash deposit - income::income::received gifts - null::to categorize::unclassified - null::null::other not computable - null::null::card adjustment - null::null::card payment - null::null::investments - null::null::internal & self transfers description: >- Taxonomy of financial transactions for categorization. Values are `family::group::leaf` codes and are what gets stored and served. Each member's docstring is the customer-facing label of that node in the taxonomy. title: FinancialTransactionCategory EntitySchema: type: object properties: name: type: string description: Name code: type: string description: Code country_code: type: string format: country description: Country Code identifier: $ref: '#/components/schemas/IdentificationNumberSchema' description: Holder identifier title: EntitySchema AccountTransactionSchema: type: object properties: type: $ref: '#/components/schemas/FinancialTransactionType' description: Transaction type status: $ref: '#/components/schemas/FinancialTransactionStatus' description: Transaction status category: $ref: '#/components/schemas/FinancialTransactionCategory' description: >- Transaction category. Transactions are classified based on their context and nature. The categorization is only applied if data enrichment is enabled for your current application. Otherwise, this field will be filled with a generic category based on the transaction amount. Contact support for more information. operation_date: type: string format: date description: >- Represents the exact moment a transaction was initiated or authorized, regardless of when it was recorded or had an effect on the balance. For instance, if a purchase was made using a credit card, the operation_date would be the date of that purchase, even if the transaction was processed or reflected in the account on subsequent dates. value_date: type: string format: date description: >- The date on which the transaction effectively impacts an account balance. It determines when interests or other time-based considerations might commence. Even though a transaction might be logged or authorized on a different date, the value_date signifies the point when it truly reflects on the account’s funds. amount: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Transaction amount balance: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Account balance after the transaction descriptions: type: array items: type: string description: Original transaction descriptions provider_id: type: string description: Unique ID for the transaction in the provider system reference: type: string description: Transaction reference payee: $ref: '#/components/schemas/EntitySchema' description: Payee information, if available payer: $ref: '#/components/schemas/EntitySchema' description: Payer information, if available merchant: $ref: '#/components/schemas/EntitySchema' description: Merchant information, if available required: - type - status - category title: AccountTransactionSchema FinancialHolderRole: type: string enum: - unknown - holder - authorized - beneficiary - other title: FinancialHolderRole AccountHolderSchema: type: object properties: role: $ref: '#/components/schemas/FinancialHolderRole' description: Holder Role name: type: string description: Holder name identifier: $ref: '#/components/schemas/IdentificationNumberSchema' description: Holder identifier current_customer: type: boolean description: Is current customer? required: - role title: AccountHolderSchema CurrentAccountSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - financial_account sub_family: type: string enum: - financial_account:current fetch_date: type: string format: datetime description: Date this product was fetched data_enrichment: $ref: '#/components/schemas/CurrentAccountSchemaDataEnrichment' description: >- Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data. identifier: $ref: '#/components/schemas/CurrentAccountSchemaIdentifier' description: Account identifier customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description opening_date: type: string format: date description: Account opening date available: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: >- The total accessible funds, considering all cleared and uncleared transactions. This represents the amount a user can use or withdraw immediately. deprecated: true booked: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: >- The net monetary amount without considering pending transactions. It reflects the actual balance at any given moment. deprecated: true transactions: type: array items: $ref: '#/components/schemas/AccountTransactionSchema' description: Account transactions holders: type: array items: $ref: '#/components/schemas/AccountHolderSchema' description: Account holders required: - id - product - sub_family - fetch_date - data_enrichment - identifier - customer_segment - product_name title: CurrentAccountSchema PaymentCardBrand: type: string enum: - American Express - Mastercard - Visa - Mir - Maestro - Discover - Verve - Dankort - Troy - UnionPay - JCB - Diners Club - other description: >- Payment card brands supported by the [`PaymentCardNumber`][pydantic_extra_types.payment.PaymentCardNumber]. title: PaymentCardBrand PanIdentifierSchema: type: object properties: type: type: string enum: - pan masked: type: string minLength: 1 maxLength: 19 description: Partial PAN brand: $ref: '#/components/schemas/PaymentCardBrand' description: Card brand required: - type - masked description: Primary Account Number title: PanIdentifierSchema FinancialCardStatus: type: string enum: - unknown - active - cancelled - blocked title: FinancialCardStatus IBANIdentifierSchema: type: object properties: value: type: string format: iban description: International Bank Account Number masked: type: string minLength: 1 maxLength: 34 description: Partial IBAN entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digits required: - value - masked - entity_country - entity_code - entity_office - control_digits description: International Bank Account Number title: IBANIdentifierSchema ClabeIdentifierSchema: type: object properties: value: type: string format: clabe description: Clave Bancaria Estandarizada masked: type: string minLength: 1 maxLength: 19 description: Partial Clabe entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digit required: - value - masked - entity_country - entity_code - entity_office - control_digits description: Clave Bancaria Estandarizada title: ClabeIdentifierSchema GenericIdentifierSchema: type: object properties: value: type: string description: Identifier entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code entity_office: type: string description: Entity office control_digits: type: string description: Control digits required: - value description: Generic account identifier title: GenericIdentifierSchema CreditCardSchemaLinkedAccount: oneOf: - $ref: '#/components/schemas/IBANIdentifierSchema' - $ref: '#/components/schemas/ClabeIdentifierSchema' - $ref: '#/components/schemas/GenericIdentifierSchema' description: Linked account, if proceeds title: CreditCardSchemaLinkedAccount CardTransactionSchema: type: object properties: type: $ref: '#/components/schemas/FinancialTransactionType' description: Transaction type status: $ref: '#/components/schemas/FinancialTransactionStatus' description: Transaction status value_date: type: string format: date description: >- Represents the moment when funds were set aside for a specific transaction, ensuring their readiness for eventual processing. From a banking perspective, this might appear as a temporary allocation or pre-authorization related to the purchase. amount: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Transaction amount descriptions: type: array items: type: string description: Original transaction descriptions provider_id: type: string description: Unique ID for the transaction in the provider system merchant: $ref: '#/components/schemas/EntitySchema' description: Merchant information, if available required: - type - status title: CardTransactionSchema CreditCardSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - financial_card sub_family: type: string enum: - financial_card:credit fetch_date: type: string format: datetime description: Date this product was fetched identifier: $ref: '#/components/schemas/PanIdentifierSchema' description: PAN entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description holder_name: type: string description: Card holder name status: $ref: '#/components/schemas/FinancialCardStatus' expiration_date: type: string format: date description: Card expiration date linked_account: $ref: '#/components/schemas/CreditCardSchemaLinkedAccount' description: Linked account, if proceeds available: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: >- The current amount of credit that a user has access to, based on their credit limit minus any current outstanding balances or pending transactions. It indicates the remaining amount the user can still borrow or use. disposed: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: The current amount of credit that a user has used or withdrawn. limit: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: >- The maximum amount of credit that a financial institution extends to a client through a line of credit. This represents the maximum amount of credit that a user can use or withdraw. payment_amount: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: >- The smallest amount that must be paid by a specified due date to keep the account in good standing and avoid potential penalties or additional interest charges. This amount generally covers the accrued interest and may include a portion of the principal balance. Paying only this amount by the due date may result in carrying a balance to the next billing cycle, which could incur interest. next_payment_date: type: string format: date description: Next Payment Date billing_period_start: type: string format: date description: Period Start Date billing_period_end: type: string format: date description: Period End Date transactions: type: array items: $ref: '#/components/schemas/CardTransactionSchema' description: Card transactions required: - id - product - sub_family - fetch_date - identifier - customer_segment - product_name - status title: CreditCardSchema DebitCardSchemaLinkedAccount: oneOf: - $ref: '#/components/schemas/IBANIdentifierSchema' - $ref: '#/components/schemas/ClabeIdentifierSchema' - $ref: '#/components/schemas/GenericIdentifierSchema' description: Linked account, if proceeds title: DebitCardSchemaLinkedAccount DebitCardSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - financial_card sub_family: type: string enum: - financial_card:debit fetch_date: type: string format: datetime description: Date this product was fetched identifier: $ref: '#/components/schemas/PanIdentifierSchema' description: PAN entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description holder_name: type: string description: Card holder name status: $ref: '#/components/schemas/FinancialCardStatus' expiration_date: type: string format: date description: Card expiration date linked_account: $ref: '#/components/schemas/DebitCardSchemaLinkedAccount' description: Linked account, if proceeds transactions: type: array items: $ref: '#/components/schemas/CardTransactionSchema' description: Card transactions required: - id - product - sub_family - fetch_date - identifier - customer_segment - product_name - status title: DebitCardSchema PrepaidCardSchemaLinkedAccount: oneOf: - $ref: '#/components/schemas/IBANIdentifierSchema' - $ref: '#/components/schemas/ClabeIdentifierSchema' - $ref: '#/components/schemas/GenericIdentifierSchema' description: Linked account, if proceeds title: PrepaidCardSchemaLinkedAccount PrepaidCardSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - financial_card sub_family: type: string enum: - financial_card:prepaid fetch_date: type: string format: datetime description: Date this product was fetched identifier: $ref: '#/components/schemas/PanIdentifierSchema' description: PAN entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description holder_name: type: string description: Card holder name status: $ref: '#/components/schemas/FinancialCardStatus' expiration_date: type: string format: date description: Card expiration date linked_account: $ref: '#/components/schemas/PrepaidCardSchemaLinkedAccount' description: Linked account, if proceeds available: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: >- For cards with a prepaid function, this indicates the current available prepaid balance that a user can access. transactions: type: array items: $ref: '#/components/schemas/CardTransactionSchema' description: Card transactions required: - id - product - sub_family - fetch_date - identifier - customer_segment - product_name - status title: PrepaidCardSchema FinancialGlobalPositionSchemaCardsItems: oneOf: - $ref: '#/components/schemas/CreditCardSchema' - $ref: '#/components/schemas/DebitCardSchema' - $ref: '#/components/schemas/PrepaidCardSchema' title: FinancialGlobalPositionSchemaCardsItems TimeDepositSchemaAccount: oneOf: - $ref: '#/components/schemas/IBANIdentifierSchema' - $ref: '#/components/schemas/ClabeIdentifierSchema' - $ref: '#/components/schemas/GenericIdentifierSchema' description: Deposit Account title: TimeDepositSchemaAccount InfonitePydanticFieldsCommonRate2Unit: oneOf: - type: string enum: - '%' - type: string format: currency title: InfonitePydanticFieldsCommonRate2Unit infonite__pydantic__fields__common___Rate__2: type: object properties: value: type: string format: number description: Decimal number with 2 digits precision unit: $ref: '#/components/schemas/InfonitePydanticFieldsCommonRate2Unit' default: '%' description: type: - string - 'null' title: infonite__pydantic__fields__common___Rate__2 TimeDepositSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - financial_deposit sub_family: type: string enum: - financial_deposit:time fetch_date: type: string format: datetime description: Date this product was fetched account: $ref: '#/components/schemas/TimeDepositSchemaAccount' description: Deposit Account contract: $ref: '#/components/schemas/GenericIdentifierSchema' description: Contract if present customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description available: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: The total accessible funds, available for withdrawal. balance: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: The amount of founds currently deposited. start_date: type: string format: date description: Deposit start date last_date: type: string format: date description: Deposit last date interest_rate: $ref: '#/components/schemas/infonite__pydantic__fields__common___Rate__2' description: Deposit interest rate required: - id - product - sub_family - fetch_date - account - customer_segment - product_name - available - balance title: TimeDepositSchema SavingsGoalSchemaAccount: oneOf: - $ref: '#/components/schemas/IBANIdentifierSchema' - $ref: '#/components/schemas/ClabeIdentifierSchema' - $ref: '#/components/schemas/GenericIdentifierSchema' description: Deposit Account title: SavingsGoalSchemaAccount SavingsGoalSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - financial_deposit sub_family: type: string enum: - financial_deposit:goal fetch_date: type: string format: datetime description: Date this product was fetched account: $ref: '#/components/schemas/SavingsGoalSchemaAccount' description: Deposit Account contract: $ref: '#/components/schemas/GenericIdentifierSchema' description: Contract if present customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description available: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: The total accessible funds, available for withdrawal. balance: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: The amount of founds currently deposited. start_date: type: string format: date description: Deposit start date last_date: type: string format: date description: Deposit last date interest_rate: $ref: '#/components/schemas/infonite__pydantic__fields__common___Rate__2' description: Deposit interest rate goal_amount: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: The goal amount of founds to be deposited. required: - id - product - sub_family - fetch_date - account - customer_segment - product_name - available - balance title: SavingsGoalSchema FinancialGlobalPositionSchemaDepositsItems: oneOf: - $ref: '#/components/schemas/TimeDepositSchema' - $ref: '#/components/schemas/SavingsGoalSchema' title: FinancialGlobalPositionSchemaDepositsItems InvestmentAccountSchemaDataEnrichment: type: string enum: - skipped - pending - processing - ready - failed description: >- Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data. title: InvestmentAccountSchemaDataEnrichment InvestmentAccountSchemaIdentifier: oneOf: - type: object properties: type: type: string enum: - clabe description: 'Discriminator value: clabe' value: type: string format: clabe description: Clave Bancaria Estandarizada masked: type: string minLength: 1 maxLength: 19 description: Partial Clabe entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digit required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: Clave Bancaria Estandarizada - type: object properties: type: type: string enum: - generic description: 'Discriminator value: generic' value: type: string description: Identifier entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code entity_office: type: string description: Entity office control_digits: type: string description: Control digits required: - type - value description: Generic account identifier - type: object properties: type: type: string enum: - iban description: 'Discriminator value: iban' value: type: string format: iban description: International Bank Account Number masked: type: string minLength: 1 maxLength: 34 description: Partial IBAN entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digits required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: International Bank Account Number discriminator: propertyName: type description: Account identifier title: InvestmentAccountSchemaIdentifier InvestmentAccountSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - financial_account sub_family: type: string enum: - financial_account:investments fetch_date: type: string format: datetime description: Date this product was fetched data_enrichment: $ref: '#/components/schemas/InvestmentAccountSchemaDataEnrichment' description: >- Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data. identifier: $ref: '#/components/schemas/InvestmentAccountSchemaIdentifier' description: Account identifier customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description opening_date: type: string format: date description: Account opening date valuation_date: type: string format: date description: Valuation date valuation: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: >- Valuation of the assets held in the account. (Deprecated, use `balance` instead) appreciation: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Monetary appreciation of the assets held in the account performance: $ref: '#/components/schemas/infonite__pydantic__fields__common___Rate__2' description: Account performance required: - id - product - sub_family - fetch_date - data_enrichment - identifier - customer_segment - product_name title: InvestmentAccountSchema InvestmentStockSchemaAccount: oneOf: - type: object properties: type: type: string enum: - clabe description: 'Discriminator value: clabe' value: type: string format: clabe description: Clave Bancaria Estandarizada masked: type: string minLength: 1 maxLength: 19 description: Partial Clabe entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digit required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: Clave Bancaria Estandarizada - type: object properties: type: type: string enum: - generic description: 'Discriminator value: generic' value: type: string description: Identifier entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code entity_office: type: string description: Entity office control_digits: type: string description: Control digits required: - type - value description: Generic account identifier - type: object properties: type: type: string enum: - iban description: 'Discriminator value: iban' value: type: string format: iban description: International Bank Account Number masked: type: string minLength: 1 maxLength: 34 description: Partial IBAN entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digits required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: International Bank Account Number discriminator: propertyName: type description: Account identifier title: InvestmentStockSchemaAccount InfoniteSchemasUtilsCurrencyAmountSchema2Currency: oneOf: - type: string format: currency - type: string enum: - '***' description: >- Three-letter ISO currency code — or `***` when the source did not disclose the currency. title: InfoniteSchemasUtilsCurrencyAmountSchema2Currency infonite__schemas__utils__CurrencyAmountSchema__2: type: object properties: currency: $ref: >- #/components/schemas/InfoniteSchemasUtilsCurrencyAmountSchema2Currency description: >- Three-letter ISO currency code — or `***` when the source did not disclose the currency. amount: type: string format: number default: nan description: Decimal number with 6 digits precision required: - currency title: infonite__schemas__utils__CurrencyAmountSchema__2 InfonitePydanticFieldsCommonRate1Unit: oneOf: - type: string enum: - '%' - type: string format: currency title: InfonitePydanticFieldsCommonRate1Unit infonite__pydantic__fields__common___Rate__1: type: object properties: value: type: string format: number default: NaN description: Decimal number with 6 digits precision unit: $ref: '#/components/schemas/InfonitePydanticFieldsCommonRate1Unit' default: '%' description: type: - string - 'null' title: infonite__pydantic__fields__common___Rate__1 InvestmentStockSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - investment_asset sub_family: type: string enum: - investment_asset:stock fetch_date: type: string format: datetime description: Date this product was fetched contract: $ref: '#/components/schemas/GenericIdentifierSchema' description: Contract if present account: $ref: '#/components/schemas/InvestmentStockSchemaAccount' description: Account identifier customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description isin: type: string description: ISIN code ticker: type: string description: Ticker market: type: string description: Market category: type: string description: Category unit_price: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__2 description: Unit price quantity: type: string format: number default: nan description: The number of units of a financial instrument held by the account. valuation: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: The monetary value of a financial instrument held by the account. valuation_date: type: string format: date description: Valuation date appreciation: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: >- The monetary value of the appreciation of a financial instrument held by the account. performance: $ref: '#/components/schemas/infonite__pydantic__fields__common___Rate__1' description: Performance required: - id - product - sub_family - fetch_date - account - customer_segment - product_name title: InvestmentStockSchema InvestmentFundSchemaSubFamily: type: string enum: - investment_asset:fund - investment_asset:etf - investment_asset:mutual - investment_asset:closed title: InvestmentFundSchemaSubFamily InvestmentFundSchemaAccount: oneOf: - type: object properties: type: type: string enum: - clabe description: 'Discriminator value: clabe' value: type: string format: clabe description: Clave Bancaria Estandarizada masked: type: string minLength: 1 maxLength: 19 description: Partial Clabe entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digit required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: Clave Bancaria Estandarizada - type: object properties: type: type: string enum: - generic description: 'Discriminator value: generic' value: type: string description: Identifier entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code entity_office: type: string description: Entity office control_digits: type: string description: Control digits required: - type - value description: Generic account identifier - type: object properties: type: type: string enum: - iban description: 'Discriminator value: iban' value: type: string format: iban description: International Bank Account Number masked: type: string minLength: 1 maxLength: 34 description: Partial IBAN entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digits required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: International Bank Account Number discriminator: propertyName: type description: Account identifier title: InvestmentFundSchemaAccount InvestmentFundSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - investment_asset sub_family: $ref: '#/components/schemas/InvestmentFundSchemaSubFamily' fetch_date: type: string format: datetime description: Date this product was fetched contract: $ref: '#/components/schemas/GenericIdentifierSchema' description: Contract if present account: $ref: '#/components/schemas/InvestmentFundSchemaAccount' description: Account identifier customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description isin: type: string description: ISIN code ticker: type: string description: Ticker market: type: string description: Market category: type: string description: Category unit_price: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__2 description: Unit price quantity: type: string format: number default: nan description: The number of units of a financial instrument held by the account. valuation: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: The monetary value of a financial instrument held by the account. valuation_date: type: string format: date description: Valuation date appreciation: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: >- The monetary value of the appreciation of a financial instrument held by the account. performance: $ref: '#/components/schemas/infonite__pydantic__fields__common___Rate__1' description: Performance required: - id - product - sub_family - fetch_date - account - customer_segment - product_name title: InvestmentFundSchema PensionPlanType: type: string enum: - pension_plan:pension title: PensionPlanType PensionPlanSchemaIdentifier: oneOf: - type: object properties: type: type: string enum: - generic description: 'Discriminator value: generic' value: type: string description: Identifier entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code entity_office: type: string description: Entity office control_digits: type: string description: Control digits required: - type - value description: Generic account identifier discriminator: propertyName: type description: Plan number title: PensionPlanSchemaIdentifier PensionPlanSchemaLinkedAccount: oneOf: - type: object properties: type: type: string enum: - clabe description: 'Discriminator value: clabe' value: type: string format: clabe description: Clave Bancaria Estandarizada masked: type: string minLength: 1 maxLength: 19 description: Partial Clabe entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digit required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: Clave Bancaria Estandarizada - type: object properties: type: type: string enum: - generic description: 'Discriminator value: generic' value: type: string description: Identifier entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code entity_office: type: string description: Entity office control_digits: type: string description: Control digits required: - type - value description: Generic account identifier - type: object properties: type: type: string enum: - iban description: 'Discriminator value: iban' value: type: string format: iban description: International Bank Account Number masked: type: string minLength: 1 maxLength: 34 description: Partial IBAN entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digits required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: International Bank Account Number discriminator: propertyName: type description: Account identifier title: PensionPlanSchemaLinkedAccount InfoniteSchemasUtilsCurrencyAmountSchema3Currency: oneOf: - type: string format: currency - type: string enum: - '***' description: >- Three-letter ISO currency code — or `***` when the source did not disclose the currency. title: InfoniteSchemasUtilsCurrencyAmountSchema3Currency infonite__schemas__utils__CurrencyAmountSchema__3: type: object properties: currency: $ref: >- #/components/schemas/InfoniteSchemasUtilsCurrencyAmountSchema3Currency description: >- Three-letter ISO currency code — or `***` when the source did not disclose the currency. amount: type: string format: number default: nan description: Decimal number with 6 digits precision required: - currency title: infonite__schemas__utils__CurrencyAmountSchema__3 InfoniteSchemasUtilsCurrencyAmountSchema4Currency: oneOf: - type: string format: currency - type: string enum: - '***' description: >- Three-letter ISO currency code — or `***` when the source did not disclose the currency. title: InfoniteSchemasUtilsCurrencyAmountSchema4Currency infonite__schemas__utils__CurrencyAmountSchema__4: type: object properties: currency: $ref: >- #/components/schemas/InfoniteSchemasUtilsCurrencyAmountSchema4Currency description: >- Three-letter ISO currency code — or `***` when the source did not disclose the currency. amount: type: string format: number default: nan description: Decimal number with 6 digits precision required: - currency title: infonite__schemas__utils__CurrencyAmountSchema__4 PensionPlanSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - pension_plan sub_family: $ref: '#/components/schemas/PensionPlanType' description: Pension plan type fetch_date: type: string format: datetime description: Date this product was fetched identifier: $ref: '#/components/schemas/PensionPlanSchemaIdentifier' description: Plan number linked_account: $ref: '#/components/schemas/PensionPlanSchemaLinkedAccount' description: Account identifier customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description category: type: string description: Plan Category begin_date: type: string format: date description: Begin date end_date: type: string format: date description: End Date total_contribution: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Total contribution year_to_date_contribution: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Year to date contribution unit_price: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__3 description: Unit price quantity: type: string format: number default: nan description: The number of units of a financial instrument held by the account. valuation: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: The monetary value of a financial instrument held by the account. valuation_date: type: string format: date description: Valuation date performance: $ref: '#/components/schemas/infonite__pydantic__fields__common___Rate__1' description: Total Performance performance_year_to_date: $ref: '#/components/schemas/infonite__pydantic__fields__common___Rate__1' description: Year to date performance performance_last_12_months: $ref: '#/components/schemas/infonite__pydantic__fields__common___Rate__1' description: Last 12 months performance appreciation: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__4 description: >- The monetary value of the appreciation of a financial instrument held by the account. required: - id - product - sub_family - fetch_date - identifier - customer_segment - product_name title: PensionPlanSchema InvestmentsFamily: type: object properties: accounts: type: array items: $ref: '#/components/schemas/InvestmentAccountSchema' description: Investment accounts stocks: type: array items: $ref: '#/components/schemas/InvestmentStockSchema' description: Investment stocks funds: type: array items: $ref: '#/components/schemas/InvestmentFundSchema' description: Investment funds pensions: type: array items: $ref: '#/components/schemas/PensionPlanSchema' description: Pension plans title: InvestmentsFamily PersonalLoanSchemaLinkedAccount: oneOf: - $ref: '#/components/schemas/IBANIdentifierSchema' - $ref: '#/components/schemas/ClabeIdentifierSchema' - $ref: '#/components/schemas/GenericIdentifierSchema' description: Linked account title: PersonalLoanSchemaLinkedAccount PersonalLoanSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - financial_loan sub_family: type: string enum: - financial_loan:personal fetch_date: type: string format: datetime description: Date this product was fetched identifier: $ref: '#/components/schemas/GenericIdentifierSchema' description: Loan identifier linked_account: $ref: '#/components/schemas/PersonalLoanSchemaLinkedAccount' description: Linked account customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description initial_balance: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Initial balance of the loan outstanding_balance: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Outstanding balance of the loan next_payment_amount: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Next payment amount begin_date: type: string format: date description: Loan start date renovation_date: type: string format: date description: Renovation Date end_date: type: string format: date description: Loan expected end date next_payment_date: type: string format: date description: Next payment date interest_rate: $ref: '#/components/schemas/infonite__pydantic__fields__common___Rate__1' description: Loan interest rate current_period: type: integer description: Current period pending_periods: type: integer description: Pending periods total_periods: type: integer description: Total periods required: - id - product - sub_family - fetch_date - identifier - customer_segment - product_name title: PersonalLoanSchema MortgageSchemaLinkedAccount: oneOf: - $ref: '#/components/schemas/IBANIdentifierSchema' - $ref: '#/components/schemas/ClabeIdentifierSchema' - $ref: '#/components/schemas/GenericIdentifierSchema' description: Linked account title: MortgageSchemaLinkedAccount MortgageSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. Note: it may change between executions. product: type: string enum: - financial_loan sub_family: type: string enum: - financial_loan:mortgage fetch_date: type: string format: datetime description: Date this product was fetched identifier: $ref: '#/components/schemas/GenericIdentifierSchema' description: Loan identifier linked_account: $ref: '#/components/schemas/MortgageSchemaLinkedAccount' description: Linked account customer_segment: $ref: '#/components/schemas/CustomerSegment' product_name: type: string description: Product name product_alias: type: string description: Product alias product_description: type: string description: Product Description initial_balance: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Initial balance of the loan outstanding_balance: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Outstanding balance of the loan next_payment_amount: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Next payment amount begin_date: type: string format: date description: Loan start date renovation_date: type: string format: date description: Renovation Date end_date: type: string format: date description: Loan expected end date next_payment_date: type: string format: date description: Next payment date interest_rate: $ref: '#/components/schemas/infonite__pydantic__fields__common___Rate__1' description: Loan interest rate current_period: type: integer description: Current period pending_periods: type: integer description: Pending periods total_periods: type: integer description: Total periods required: - id - product - sub_family - fetch_date - identifier - customer_segment - product_name title: MortgageSchema FinancialGlobalPositionSchemaLoansItems: oneOf: - $ref: '#/components/schemas/PersonalLoanSchema' - $ref: '#/components/schemas/MortgageSchema' title: FinancialGlobalPositionSchemaLoansItems SepaDirectDebitSchemaAccount: oneOf: - type: object properties: type: type: string enum: - clabe description: 'Discriminator value: clabe' value: type: string format: clabe description: Clave Bancaria Estandarizada masked: type: string minLength: 1 maxLength: 19 description: Partial Clabe entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digit required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: Clave Bancaria Estandarizada - type: object properties: type: type: string enum: - generic description: 'Discriminator value: generic' value: type: string description: Identifier entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code entity_office: type: string description: Entity office control_digits: type: string description: Control digits required: - type - value description: Generic account identifier - type: object properties: type: type: string enum: - iban description: 'Discriminator value: iban' value: type: string format: iban description: International Bank Account Number masked: type: string minLength: 1 maxLength: 34 description: Partial IBAN entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digits required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: International Bank Account Number discriminator: propertyName: type description: The customer's account the debit is charged to. title: SepaDirectDebitSchemaAccount DirectDebitStatus: type: string enum: - unknown - active - cancelled - suspended - expired title: DirectDebitStatus BeneficiarySchemaAccount: oneOf: - type: object properties: type: type: string enum: - clabe description: 'Discriminator value: clabe' value: type: string format: clabe description: Clave Bancaria Estandarizada masked: type: string minLength: 1 maxLength: 19 description: Partial Clabe entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digit required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: Clave Bancaria Estandarizada - type: object properties: type: type: string enum: - generic description: 'Discriminator value: generic' value: type: string description: Identifier entity_country: type: string format: country description: Entity country entity_code: type: string description: Entity code entity_office: type: string description: Entity office control_digits: type: string description: Control digits required: - type - value description: Generic account identifier - type: object properties: type: type: string enum: - iban description: 'Discriminator value: iban' value: type: string format: iban description: International Bank Account Number masked: type: string minLength: 1 maxLength: 34 description: Partial IBAN entity_country: type: string description: Bank Country entity_code: type: string description: Bank code entity_office: type: string description: Bank office control_digits: type: string description: Control digits required: - type - value - masked - entity_country - entity_code - entity_office - control_digits description: International Bank Account Number discriminator: propertyName: type description: Account the beneficiary collects into, when the bank discloses it. title: BeneficiarySchemaAccount BeneficiarySchema: type: object properties: identifier: type: string description: Beneficiary identifier, as the bank reports it. name: type: string description: Beneficiary name. account: $ref: '#/components/schemas/BeneficiarySchemaAccount' description: Account the beneficiary collects into, when the bank discloses it. tax_id: type: string description: Beneficiary tax ID, when the bank discloses it. description: Who collects the debit. title: BeneficiarySchema PayerSchema: type: object properties: name: type: string description: Payer name. identifier: type: string description: Payer identifier, as the bank reports it. description: Who pays the debit. title: PayerSchema DirectDebitTransactionSchema: type: object properties: status: $ref: '#/components/schemas/FinancialTransactionStatus' description: Status of this charge. issue_date: type: string format: datetime description: Date the charge was issued. payment_date: type: string format: datetime description: Date the charge was paid. concept: type: string description: Concept of the charge, as the bank reports it. amount: $ref: >- #/components/schemas/infonite__schemas__utils__CurrencyAmountSchema__1 description: Amount of the charge. required: - status description: >- One charge of the direct debit: when it was issued and paid, and for how much. title: DirectDebitTransactionSchema ProductAttachmentType: type: string enum: - attachment:attachment - attachment:supplier_invoice - attachment:client_invoice - attachment:es-tgss-life-report - attachment:es-tgss-contribution-base-report - attachment:es-aeat-model-100 - attachment:es-cirbe-report - attachment:sepa-direct-debit-bill description: Product Attachment Type title: ProductAttachmentType FileAttachmentSchema: type: object properties: product: type: string enum: - attachment default: attachment description: The product type identifier. Always `attachment`. sub_family: $ref: '#/components/schemas/ProductAttachmentType' description: >- What kind of document this is (e.g. `attachment:es-tgss-life-report`). id: type: string format: object-id description: >- Attachment identifier — use it to download the file through the execution's attachments endpoint. content_name: type: string description: File name of the document. content_hash: type: string description: Fingerprint of the content, to verify its integrity. content_type: type: string format: mime-type description: MIME type of the content. metadata: type: object additionalProperties: description: Any type description: >- Extra facts about the document, as simple key-value pairs (e.g. its official verification code, its issue date). required: - sub_family - id - content_name - content_type - metadata description: >- A document attached to a result — an official report, a receipt, an invoice... The entry describes the file; its bytes are downloaded through the execution's attachments endpoint using `id`. title: FileAttachmentSchema SEPADirectDebitSchema: type: object properties: id: type: string format: object-id description: >- Product ID for the current execution. It may change between executions. product: type: string enum: - direct_debit sub_family: type: string enum: - direct_debit:sepa fetch_date: type: string format: datetime description: Date this product was fetched. account: $ref: '#/components/schemas/SepaDirectDebitSchemaAccount' description: The customer's account the debit is charged to. debit_reference: type: string description: Mandate/debit reference, as the bank reports it. status: $ref: '#/components/schemas/DirectDebitStatus' description: Status of the direct debit authorization. customer_segment: $ref: '#/components/schemas/CustomerSegment' description: >- Whether the account belongs to a personal or a business relationship. beneficiary: $ref: '#/components/schemas/BeneficiarySchema' payer: $ref: '#/components/schemas/PayerSchema' transactions: type: array items: $ref: '#/components/schemas/DirectDebitTransactionSchema' description: Recent charges of this debit, as reported by the bank. attachments: type: array items: $ref: '#/components/schemas/FileAttachmentSchema' default: [] description: >- Supporting documents of the debit — e.g. the receipt of the most recent charge. Each entry's `id` downloads the file through the execution's attachments endpoint. required: - id - product - sub_family - fetch_date - account - status - customer_segment - beneficiary - payer - transactions description: >- A SEPA direct debit authorization, with its recent charges and supporting documents. title: SEPADirectDebitSchema FinancialGlobalPositionSchema: type: object properties: customer: $ref: '#/components/schemas/CustomerFamily' description: Customer family accounts: type: array items: $ref: '#/components/schemas/CurrentAccountSchema' description: Current accounts cards: type: array items: $ref: '#/components/schemas/FinancialGlobalPositionSchemaCardsItems' description: Cards deposits: type: array items: $ref: '#/components/schemas/FinancialGlobalPositionSchemaDepositsItems' description: Deposits investments: $ref: '#/components/schemas/InvestmentsFamily' description: Investments family loans: type: array items: $ref: '#/components/schemas/FinancialGlobalPositionSchemaLoansItems' description: Loans direct_debits: type: array items: $ref: '#/components/schemas/SEPADirectDebitSchema' description: Direct debits title: FinancialGlobalPositionSchema ``` --- ## 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: | Field | What it is | | :------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | The 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_family` | What 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_date` | When this particular product was read. | | `product_name` · `product_alias` · `product_description` | What 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_segment` | Retail or business, as the institution classifies the holder. | | `data_enrichment` | Whether 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](/direct-executions/results). --- ## The pages in this family #### [Accounts](/guides/data-models/banking/accounts) Current and savings accounts, their balances, their holders, and the transactions behind them — categorised. #### [Cards](/guides/data-models/banking/cards) Debit, credit and prepaid cards, their limits and their movements. #### [Loans & mortgages](/guides/data-models/banking/credit) What is owed to this institution: amount granted, outstanding, instalment and rate. #### [Deposits & savings](/guides/data-models/banking/savings) Term deposits and savings goals — money set aside, and what it is being set aside for. #### [Investments](/guides/data-models/banking/investments) Securities accounts, stocks, funds and private pension plans, with valuations and performance. #### [Direct debits](/guides/data-models/banking/direct-debits) The standing charges against an account: who charges, how much, how often. #### [Customer Profile](/guides/data-models/customer-profile) The `customer` key of the position: who the institution says your customer is. Shared with every other family.