> This page is for Financial Rider Flow. > 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. # On Flow Ended POST Triggered once, when the session finishes — with the results of what it connected, or with the reason it has none. **This is the event that means finished.** Its payload carries **`is_closed: true`** at the top — however the session ended, with an `aes_key` or without one —, and that field, not the widget closing nor your customer leaving, is what tells you a session is over and its results are final. **The schema below describes `data` decrypted — on purpose**, so this reference has a model you can read and code against. What arrives at your endpoint depends on how the session was created: * **With an `aes_key`**: `data` is a single string, `aes::Base64(IV + Ciphertext + Tag)`. Decrypt it and you get exactly the object documented below. The walkthrough and the code are in [Payload Encryption](/guides/payload-encryption). * **Without an `aes_key`**: `data` is **not in the body at all** — absent, not `null`. Your customer's financial records never travel in the clear: read them from [Get Session Results](https://infonite.dev/flows/financial-rider/api-reference/financial-rider-api/sessions-results/flows-financial-rider-v-1-session-results). Cancelled by your customer, cancelled by you before anything was connected, timed out, failed: `status_code` says which, and `data` then carries the reason rather than the records — `user_feedback` with what your customer answered in the cancellation dialog, `system_feedback` when the platform is what stopped it. **No results are coming afterwards.** **`messages`: what the session found, beside what it read.** The `messages` list carries the situations the session detected — most sessions carry none. Route the **`flag`** ones: they mean the session found something about your customer or their data that deserves a decision on yours, such as two banks that disagree about who your customer is. Automate on `message_id`, never on the wording. Events are delivered **at least once**: deduplicate by `session_id` and `event`. **Answer `2xx` as soon as the payload reaches you**, whatever your processing does with it afterwards: any other status is recorded as a failed delivery even though the event arrived. [Answering a delivery](/guides/webhooks#answering-a-delivery) has the handler to copy. Reference: https://infonite.dev/flows/financial-rider/api-reference/financial-rider-api/webhooks/webhook-financial-rider-ended ## Request ### Payload - `event_class` ("FinancialRiderV1FlowEvent", required) — Payload class discriminator — always this value for Financial Rider events. - `app_id` (string, required) - `customer_id` (string, required) - `session_id` (string, required) - `producer` ("financial-rider", required) — The flow that produced the event. - `event` ("financial-rider:ended", required) — The event type: `ended`. - `status_code` (enum, required) — Describes the status of a flow. - Allowed values: `READY`, `WAITING`, `COMPLETED`, `FAILED`, `SYSTEM_CANCELLED`, `CLIENT_CANCELLED`, `CUSTOMER_CANCELLED`, `TIMED_OUT`, `CONFIGURATION_ERROR` - `is_closed` (true, required) — Always `true`: the session is over and its results are final — however it ended, and whether `data` travels or not. This field, not the widget closing, is what says a session is finished. - `date` (string, optional) - `status_message` (string, optional, nullable) - `data` (WebhookEndedPayloadData, optional) — The session's final results. - **Documented decrypted, delivered encrypted.** With an `aes_key` on the session this field is the `aes::Base64(IV + Ciphertext + Tag)` string of the object described here, which decrypts into the session results; without one it is not in the body at all, and the results are read from the session results endpoint instead. - A session that ended without results — cancelled, timed out, failed — carries the reason instead, as `WebhookEndedErrorPayload`. ## Types ### WebhookEndedPayloadData The session's final results. - **Documented decrypted, delivered encrypted.** With an `aes_key` on the session this field is the `aes::Base64(IV + Ciphertext + Tag)` string of the object described here, which decrypts into the session results; without one it is not in the body at all, and the results are read from the session results endpoint instead. - A session that ended without results — cancelled, timed out, failed — carries the reason instead, as `WebhookEndedErrorPayload`. - Financial Rider v1 - Results: FlowResultsSchema - Financial Rider v1 - Ended Error Payload: WebhookEndedErrorPayload ### FlowResultsSchema - `is_closed` (boolean, required) — Whether the session is over. `false` means these are the results gathered so far, and more may come. - `status_code` (enum, required) — The status of the session. - Allowed values: `READY`, `WAITING`, `COMPLETED`, `FAILED`, `SYSTEM_CANCELLED`, `CLIENT_CANCELLED`, `CUSTOMER_CANCELLED`, `TIMED_OUT`, `CONFIGURATION_ERROR` - `cursor` (enum, required) — The last screen the end user reached. - Allowed values: `financial-rider:welcome:init`, `financial-rider:welcome:consent`, `financial-rider:connect:source`, `financial-rider:bye:completed`, `financial-rider:bye:failure` - `connections` (map from string to string, required) — The entities that connected, by execution id, with the engine that read each one. Only connections that finished are listed; with `tokenized_access`, these are the ids to exchange the ticket with. - `consent` (ConsentOutput, optional) — What the end user consented to, and the proof of it. Absent when the session showed no consent screen. - `retrieved_features` (list of enum, optional) — The features some connection actually delivered. - Allowed values: `accounts_read`, `cards_read`, `deposits_read`, `loans_read`, `credits_read`, `investment_accounts_read`, `funds_read`, `stocks_read`, `pensions_read`, `accounts_certificates`, `direct_debits_read`, `customer_information_read`, `source_contracts_read`, `cloud_resource_read`, `supplier_invoices_read`, `client_invoices_read`, `labor_check`, `public_pensions`, `public_document_verification`, `yearly_individual_tax`, `vehicles_data`, `driver_data`, `academic_data`, `properties_data`, `credit_registry_data` - `data` (FinancialGlobalPositionSchema, optional) — Everything the connections read, merged into one financial position. Absent when the session ended without results: cancelled by the end user, failed or timed out. - `messages` (list of MessageOutput, optional, default: []) — What the session has to say about itself and about the data it read, oldest first. Most sessions say nothing. A situation is reported once however many times it occurred: automate on `message_id`, and treat `message` as text for a person. ### WebhookEndedErrorPayload Why a session ended without results: your customer's cancellation feedback, or the platform's failure details. - `user_feedback` (CustomerExitFeedback, optional) — Why your customer left, when they left from the widget. - `system_feedback` (map from string to any, optional) — What stopped the session, when the platform did. ### ConsentOutput What the end user consented to, and from where. - `accepted_date` (string, required) — When the end user consented. - `accepted_features` (list of enum, required) — What they authorized the session to read. - Allowed values: `accounts_read`, `cards_read`, `deposits_read`, `loans_read`, `credits_read`, `investment_accounts_read`, `funds_read`, `stocks_read`, `pensions_read`, `accounts_certificates`, `direct_debits_read`, `customer_information_read`, `source_contracts_read`, `cloud_resource_read`, `supplier_invoices_read`, `client_invoices_read`, `labor_check`, `public_pensions`, `public_document_verification`, `yearly_individual_tax`, `vehicles_data`, `driver_data`, `academic_data`, `properties_data`, `credit_registry_data` - `user_ip` (string, optional) — The IP address of the device they consented from. - `user_agent` (string, optional) — The browser they consented from. - `origin` (string, optional) — The page the widget was embedded in. - `accepted_documents` (map from string to AcceptedDocumentSchema, optional, default: {}) — The documents shown on the consent screen, by slot, each with the exact version and digest the end user was shown. Empty when your application shows none. ### FinancialGlobalPositionSchema - `customer` (CustomerFamily, optional) — Customer family - `accounts` (list of CurrentAccountSchema, optional) — Current accounts - `cards` (list of FinancialGlobalPositionSchemaCardsItems, optional) — Cards - `deposits` (list of FinancialGlobalPositionSchemaDepositsItems, optional) — Deposits - `investments` (InvestmentsFamily, optional) — Investments family - `loans` (list of FinancialGlobalPositionSchemaLoansItems, optional) — Loans - `direct_debits` (list of SEPADirectDebitSchema, optional) — Direct debits ### MessageOutput Something the session has to say about itself or about what it read. - `type` (enum, required) — The kind of message: `error`, `warning`, `flag` or `info`. A `flag` is the one raised for you to act on: nothing failed on our side, and the session still found something that deserves a decision. - Allowed values: `error`, `warning`, `info`, `flag` - `message_id` (string, required) — The stable identifier of the SITUATION, such as `crossed_identity`. Automate on this value: the wording of `message` may change without the situation becoming another one. - `date_created` (string, required) — When the situation was first detected during the session. - `location` (list of MessageOutputLocationItems, optional, default: []) — Where in this results document the message applies, as a `loc` list — strings for fields, integers for array positions (`["data", "customer", "profile"]`). An empty list means the message is about the session as a whole. - `message` (string, optional) — A human-readable description of the situation, when there is one to add. ### CustomerExitFeedback Why your customer left the session from the widget. - `reason` (enum, required) — The option they chose in the widget's exit dialog: - `took_too_long`: it took too long to load. - `entity_not_listed`: their bank or entity is not among the ones offered. - `missing_credentials`: they do not have their bank's credentials at hand. - `distrust`: they do not trust this way of sharing their data. - `unclear_steps`: they do not know what they have to do. - `other`: none of the above. - Allowed values: `took_too_long`, `entity_not_listed`, `missing_credentials`, `distrust`, `unclear_steps`, `other` - `feedback` (string, optional) — What they wrote, as they wrote it — the entity they were looking for, when they chose `entity_not_listed`, or their own words, when they chose `other`. ### AcceptedDocumentSchema - `version` (string, required) — The version of the document the end user was shown. - `hash` (string, required) — The SHA-256 digest of its exact text. - `sign_date` (string, optional) — When the end user signed it, to the minute. Absent for a document only presented and accepted with the consent. - `signature_provider` (string, optional) — How it was signed. Absent for a document only presented. ### CustomerFamily - `profile` (CustomerProfileSchema, optional) — Customer profile ### CurrentAccountSchema - `id` (string, required) — Product ID for the current execution. Note: it may change between executions. - `product` ("financial_account", required) - `sub_family` ("financial_account:current", required) - `fetch_date` (string, required) — Date this product was fetched - `data_enrichment` (enum, required) — Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data. - Allowed values: `skipped`, `pending`, `processing`, `ready`, `failed` - `identifier` (CurrentAccountSchemaIdentifier, required) — Account identifier - `customer_segment` (enum, required) - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `product_name` (string, required) — Product name - `product_alias` (string, optional) — Product alias - `product_description` (string, optional) — Product Description - `opening_date` (date, optional) — Account opening date - `transactions` (list of AccountTransactionSchema, optional) — Account transactions - `holders` (list of AccountHolderSchema, optional) — Account holders - `available` (infonite__schemas__utils__CurrencyAmountSchema__1, optional, deprecated) — The total accessible funds, considering all cleared and uncleared transactions. This represents the amount a user can use or withdraw immediately. - `booked` (infonite__schemas__utils__CurrencyAmountSchema__1, optional, deprecated) — The net monetary amount without considering pending transactions. It reflects the actual balance at any given moment. ### FinancialGlobalPositionSchemaCardsItems - Credit Card: CreditCardSchema - Debit Card: DebitCardSchema - Prepaid Card: PrepaidCardSchema ### FinancialGlobalPositionSchemaDepositsItems - Time Deposit: TimeDepositSchema - Savings Goal: SavingsGoalSchema ### InvestmentsFamily - `accounts` (list of InvestmentAccountSchema, optional) — Investment accounts - `stocks` (list of InvestmentStockSchema, optional) — Investment stocks - `funds` (list of InvestmentFundSchema, optional) — Investment funds - `pensions` (list of PensionPlanSchema, optional) — Pension plans ### FinancialGlobalPositionSchemaLoansItems - Personal Loan: PersonalLoanSchema - Mortgage: MortgageSchema ### SEPADirectDebitSchema A SEPA direct debit authorization, with its recent charges and supporting documents. - `id` (string, required) — Product ID for the current execution. It may change between executions. - `product` ("direct_debit", required) - `sub_family` ("direct_debit:sepa", required) - `fetch_date` (string, required) — Date this product was fetched. - `account` (SepaDirectDebitSchemaAccount, required) — The customer's account the debit is charged to. - `status` (enum, required) — Status of the direct debit authorization. - Allowed values: `unknown`, `active`, `cancelled`, `suspended`, `expired` - `customer_segment` (enum, required) — Whether the account belongs to a personal or a business relationship. - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `beneficiary` (BeneficiarySchema, required) — Who collects the debit. - `payer` (PayerSchema, required) — Who pays the debit. - `transactions` (list of DirectDebitTransactionSchema, required) — Recent charges of this debit, as reported by the bank. - `debit_reference` (string, optional) — Mandate/debit reference, as the bank reports it. - `attachments` (list of FileAttachmentSchema, optional, default: []) — Supporting documents of the debit — e.g. the receipt of the most recent charge. Each entry's `id` downloads the file through the attachments endpoint of the API that returned this debit. ### MessageOutputLocationItems - string - integer ### CustomerProfileSchema 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`. - `product` ("customer_information", required) — The product type identifier. Always `customer_information` for this product. - `sub_family` ("customer_information:user_profile", required) — The sub-family identifier: `customer_information:user_profile`, the customer's profile at the institution. - `fetch_date` (string, required) — Date this information was fetched. - `type` (enum, required) — The kind of customer: a person or a company. This is the switch that tells you how to read the rest of the profile. - Allowed values: `person`, `company`, `unknown` - `identification_numbers` (list of IdentificationNumberSchema, required) — 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. - `gender` (enum, required) — **Persons only** — gender as declared at the institution. `unknown` for companies, and for persons whose source does not disclose it. - Allowed values: `male`, `female`, `rather_not_say`, `unknown` - `civil_status` (enum, required) — **Persons only** — civil status as declared at the institution. `unknown` for companies, and for persons whose source does not disclose it. - Allowed values: `single`, `married`, `divorced`, `widowed`, `separated`, `unknown` - `emails` (list of string, required) — Email addresses of the customer, as they appear at the source. - `phones` (list of string, required) — Phone numbers of the customer, as they appear at the source. - `addresses` (list of AddressSchema, required) — Postal addresses of the customer, as they appear at the source. - `name` (string, optional) — For persons, the given name(s); for companies, the registered legal name (razón social). - `name_extra` (string, optional) — **Persons only** — the rest of the legal name; Spanish institutions report both surnames here. Empty for companies. - `alias` (string, optional) — How the institution addresses the customer when it differs from the legal name — a chosen or commercial name. - `birth_date` (date, optional) — For persons, the date of birth; for companies, the date of incorporation, when the source provides it. - `birth_country` (string, optional) — Country of birth, as a two-letter ISO code. - `nationality_country` (string, optional) — For persons, the country of nationality; for companies, the country of the registered seat. Two-letter ISO code. - `residence_country` (string, optional) — For persons, the country of residence; for companies, the country of its tax residence. Two-letter ISO code. - `number_of_children` (integer, optional) — **Persons only** — number of children, when the institution records it. Empty for companies. - `language` (string, optional) — The customer's preferred language, as an ISO language code. - `member_since` (date, optional) — Date the customer's relationship with the institution began, when the source reports it. ### CurrentAccountSchemaIdentifier Account identifier - `type`: `clabe` (CLABE) - `control_digits` (string, required) — Control digit - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial Clabe - `value` (string, required) — Clave Bancaria Estandarizada - `type`: `generic` (Generic Identifier) - `value` (string, required) — Identifier - `control_digits` (string, optional) — Control digits - `entity_code` (string, optional) — Entity code - `entity_country` (string, optional) — Entity country - `entity_office` (string, optional) — Entity office - `type`: `iban` (IBAN) - `control_digits` (string, required) — Control digits - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial IBAN - `value` (string, required) — International Bank Account Number ### AccountTransactionSchema - `type` (enum, required) — Transaction type - Allowed values: `unknown`, `opening`, `closure`, `credit`, `debit`, `default` - `status` (enum, required) — Transaction status - Allowed values: `unknown`, `pending`, `booked`, `cancelled`, `failed`, `reversed` - `category` (enum, required) — 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. - Allowed values: `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` - `operation_date` (date, optional) — 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` (date, optional) — 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` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Transaction amount - `balance` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Account balance after the transaction - `descriptions` (list of string, optional) — Original transaction descriptions - `provider_id` (string, optional) — Unique ID for the transaction in the provider system - `reference` (string, optional) — Transaction reference - `payee` (EntitySchema, optional) — Payee information, if available - `payer` (EntitySchema, optional) — Payer information, if available - `merchant` (EntitySchema, optional) — Merchant information, if available ### AccountHolderSchema - `role` (enum, required) — Holder Role - Allowed values: `unknown`, `holder`, `authorized`, `beneficiary`, `other` - `name` (string, optional) — Holder name - `identifier` (IdentificationNumberSchema, optional) — Holder identifier - `current_customer` (boolean, optional) — Is current customer? ### infonite__schemas__utils__CurrencyAmountSchema__1 A monetary amount together with its currency. - `currency` (InfoniteSchemasUtilsCurrencyAmountSchema1Currency, required) — Three-letter ISO currency code — or `***` when the source did not disclose the currency. - `amount` (string, required) — Decimal number with 2 digits precision ### CreditCardSchema - `id` (string, required) — Product ID for the current execution. Note: it may change between executions. - `product` ("financial_card", required) - `sub_family` ("financial_card:credit", required) - `fetch_date` (string, required) — Date this product was fetched - `identifier` (PanIdentifierSchema, required) — PAN - `customer_segment` (enum, required) - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `product_name` (string, required) — Product name - `status` (enum, required) - Allowed values: `unknown`, `active`, `cancelled`, `blocked` - `entity_country` (string, optional) — Entity country - `entity_code` (string, optional) — Entity code - `product_alias` (string, optional) — Product alias - `product_description` (string, optional) — Product Description - `holder_name` (string, optional) — Card holder name - `expiration_date` (date, optional) — Card expiration date - `linked_account` (CreditCardSchemaLinkedAccount, optional) — Linked account, if proceeds - `available` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — 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` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — The current amount of credit that a user has used or withdrawn. - `limit` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — 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` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — 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` (date, optional) — Next Payment Date - `billing_period_start` (date, optional) — Period Start Date - `billing_period_end` (date, optional) — Period End Date - `transactions` (list of CardTransactionSchema, optional) — Card transactions ### DebitCardSchema - `id` (string, required) — Product ID for the current execution. Note: it may change between executions. - `product` ("financial_card", required) - `sub_family` ("financial_card:debit", required) - `fetch_date` (string, required) — Date this product was fetched - `identifier` (PanIdentifierSchema, required) — PAN - `customer_segment` (enum, required) - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `product_name` (string, required) — Product name - `status` (enum, required) - Allowed values: `unknown`, `active`, `cancelled`, `blocked` - `entity_country` (string, optional) — Entity country - `entity_code` (string, optional) — Entity code - `product_alias` (string, optional) — Product alias - `product_description` (string, optional) — Product Description - `holder_name` (string, optional) — Card holder name - `expiration_date` (date, optional) — Card expiration date - `linked_account` (DebitCardSchemaLinkedAccount, optional) — Linked account, if proceeds - `transactions` (list of CardTransactionSchema, optional) — Card transactions ### PrepaidCardSchema - `id` (string, required) — Product ID for the current execution. Note: it may change between executions. - `product` ("financial_card", required) - `sub_family` ("financial_card:prepaid", required) - `fetch_date` (string, required) — Date this product was fetched - `identifier` (PanIdentifierSchema, required) — PAN - `customer_segment` (enum, required) - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `product_name` (string, required) — Product name - `status` (enum, required) - Allowed values: `unknown`, `active`, `cancelled`, `blocked` - `entity_country` (string, optional) — Entity country - `entity_code` (string, optional) — Entity code - `product_alias` (string, optional) — Product alias - `product_description` (string, optional) — Product Description - `holder_name` (string, optional) — Card holder name - `expiration_date` (date, optional) — Card expiration date - `linked_account` (PrepaidCardSchemaLinkedAccount, optional) — Linked account, if proceeds - `available` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — For cards with a prepaid function, this indicates the current available prepaid balance that a user can access. - `transactions` (list of CardTransactionSchema, optional) — Card transactions ### TimeDepositSchema - `id` (string, required) — Product ID for the current execution. Note: it may change between executions. - `product` ("financial_deposit", required) - `sub_family` ("financial_deposit:time", required) - `fetch_date` (string, required) — Date this product was fetched - `account` (TimeDepositSchemaAccount, required) — Deposit Account - `customer_segment` (enum, required) - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `product_name` (string, required) — Product name - `available` (infonite__schemas__utils__CurrencyAmountSchema__1, required) — The total accessible funds, available for withdrawal. - `balance` (infonite__schemas__utils__CurrencyAmountSchema__1, required) — The amount of founds currently deposited. - `contract` (Generic Identifier, optional) — Contract if present - `product_alias` (string, optional) — Product alias - `product_description` (string, optional) — Product Description - `start_date` (date, optional) — Deposit start date - `last_date` (date, optional) — Deposit last date - `interest_rate` (infonite__pydantic__fields__common___Rate__1, optional) — Deposit interest rate ### SavingsGoalSchema - `id` (string, required) — Product ID for the current execution. Note: it may change between executions. - `product` ("financial_deposit", required) - `sub_family` ("financial_deposit:goal", required) - `fetch_date` (string, required) — Date this product was fetched - `account` (SavingsGoalSchemaAccount, required) — Deposit Account - `customer_segment` (enum, required) - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `product_name` (string, required) — Product name - `available` (infonite__schemas__utils__CurrencyAmountSchema__1, required) — The total accessible funds, available for withdrawal. - `balance` (infonite__schemas__utils__CurrencyAmountSchema__1, required) — The amount of founds currently deposited. - `contract` (Generic Identifier, optional) — Contract if present - `product_alias` (string, optional) — Product alias - `product_description` (string, optional) — Product Description - `start_date` (date, optional) — Deposit start date - `last_date` (date, optional) — Deposit last date - `interest_rate` (infonite__pydantic__fields__common___Rate__1, optional) — Deposit interest rate - `goal_amount` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — The goal amount of founds to be deposited. ### InvestmentAccountSchema - `id` (string, required) — Product ID for the current execution. Note: it may change between executions. - `product` ("financial_account", required) - `sub_family` ("financial_account:investments", required) - `fetch_date` (string, required) — Date this product was fetched - `data_enrichment` (enum, required) — Data enrichment status. Indicates whether the product has been enriched with additional data. If not, the product will be filled with generic data. - Allowed values: `skipped`, `pending`, `processing`, `ready`, `failed` - `identifier` (InvestmentAccountSchemaIdentifier, required) — Account identifier - `customer_segment` (enum, required) - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `product_name` (string, required) — Product name - `product_alias` (string, optional) — Product alias - `product_description` (string, optional) — Product Description - `opening_date` (date, optional) — Account opening date - `valuation_date` (date, optional) — Valuation date - `valuation` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Valuation of the assets held in the account. (Deprecated, use `balance` instead) - `appreciation` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Monetary appreciation of the assets held in the account - `performance` (infonite__pydantic__fields__common___Rate__1, optional) — Account performance ### InvestmentStockSchema - `id` (string, required) — Product ID for the current execution. Note: it may change between executions. - `product` ("investment_asset", required) - `sub_family` ("investment_asset:stock", required) - `fetch_date` (string, required) — Date this product was fetched - `account` (InvestmentStockSchemaAccount, required) — Account identifier - `customer_segment` (enum, required) - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `product_name` (string, required) — Product name - `contract` (Generic Identifier, optional) — Contract if present - `product_alias` (string, optional) — Product alias - `product_description` (string, optional) — Product Description - `isin` (string, optional) — ISIN code - `ticker` (string, optional) — Ticker - `market` (string, optional) — Market - `category` (string, optional) — Category - `unit_price` (infonite__schemas__utils__CurrencyAmountSchema__2, optional) — Unit price - `quantity` (string, optional, default: nan) — The number of units of a financial instrument held by the account. - `valuation` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — The monetary value of a financial instrument held by the account. - `valuation_date` (date, optional) — Valuation date - `appreciation` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — The monetary value of the appreciation of a financial instrument held by the account. - `performance` (infonite__pydantic__fields__common___Rate__2, optional) — Performance ### InvestmentFundSchema - `id` (string, required) — Product ID for the current execution. Note: it may change between executions. - `product` ("investment_asset", required) - `sub_family` (enum, required) - Allowed values: `investment_asset:fund`, `investment_asset:etf`, `investment_asset:mutual`, `investment_asset:closed` - `fetch_date` (string, required) — Date this product was fetched - `account` (InvestmentFundSchemaAccount, required) — Account identifier - `customer_segment` (enum, required) - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `product_name` (string, required) — Product name - `contract` (Generic Identifier, optional) — Contract if present - `product_alias` (string, optional) — Product alias - `product_description` (string, optional) — Product Description - `isin` (string, optional) — ISIN code - `ticker` (string, optional) — Ticker - `market` (string, optional) — Market - `category` (string, optional) — Category - `unit_price` (infonite__schemas__utils__CurrencyAmountSchema__2, optional) — Unit price - `quantity` (string, optional, default: nan) — The number of units of a financial instrument held by the account. - `valuation` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — The monetary value of a financial instrument held by the account. - `valuation_date` (date, optional) — Valuation date - `appreciation` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — The monetary value of the appreciation of a financial instrument held by the account. - `performance` (infonite__pydantic__fields__common___Rate__2, optional) — Performance ### PensionPlanSchema - `id` (string, required) — Product ID for the current execution. Note: it may change between executions. - `product` ("pension_plan", required) - `sub_family` (enum, required) — Pension plan type - Allowed values: `pension_plan:pension` - `fetch_date` (string, required) — Date this product was fetched - `identifier` (PensionPlanSchemaIdentifier, required) — Plan number - `customer_segment` (enum, required) - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `product_name` (string, required) — Product name - `linked_account` (PensionPlanSchemaLinkedAccount, optional) — Account identifier - `product_alias` (string, optional) — Product alias - `product_description` (string, optional) — Product Description - `category` (string, optional) — Plan Category - `begin_date` (date, optional) — Begin date - `end_date` (date, optional) — End Date - `total_contribution` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Total contribution - `year_to_date_contribution` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Year to date contribution - `unit_price` (infonite__schemas__utils__CurrencyAmountSchema__3, optional) — Unit price - `quantity` (string, optional, default: nan) — The number of units of a financial instrument held by the account. - `valuation` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — The monetary value of a financial instrument held by the account. - `valuation_date` (date, optional) — Valuation date - `performance` (infonite__pydantic__fields__common___Rate__2, optional) — Total Performance - `performance_year_to_date` (infonite__pydantic__fields__common___Rate__2, optional) — Year to date performance - `performance_last_12_months` (infonite__pydantic__fields__common___Rate__2, optional) — Last 12 months performance - `appreciation` (infonite__schemas__utils__CurrencyAmountSchema__4, optional) — The monetary value of the appreciation of a financial instrument held by the account. ### PersonalLoanSchema - `id` (string, required) — Product ID for the current execution. Note: it may change between executions. - `product` ("financial_loan", required) - `sub_family` ("financial_loan:personal", required) - `fetch_date` (string, required) — Date this product was fetched - `identifier` (Generic Identifier, required) — Loan identifier - `customer_segment` (enum, required) - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `product_name` (string, required) — Product name - `linked_account` (PersonalLoanSchemaLinkedAccount, optional) — Linked account - `product_alias` (string, optional) — Product alias - `product_description` (string, optional) — Product Description - `initial_balance` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Initial balance of the loan - `outstanding_balance` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Outstanding balance of the loan - `next_payment_amount` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Next payment amount - `begin_date` (date, optional) — Loan start date - `renovation_date` (date, optional) — Renovation Date - `end_date` (date, optional) — Loan expected end date - `next_payment_date` (date, optional) — Next payment date - `interest_rate` (infonite__pydantic__fields__common___Rate__2, optional) — Loan interest rate - `current_period` (integer, optional) — Current period - `pending_periods` (integer, optional) — Pending periods - `total_periods` (integer, optional) — Total periods ### MortgageSchema - `id` (string, required) — Product ID for the current execution. Note: it may change between executions. - `product` ("financial_loan", required) - `sub_family` ("financial_loan:mortgage", required) - `fetch_date` (string, required) — Date this product was fetched - `identifier` (Generic Identifier, required) — Loan identifier - `customer_segment` (enum, required) - Allowed values: `not_assigned`, `personal`, `business`, `corporate`, `private`, `retail` - `product_name` (string, required) — Product name - `linked_account` (MortgageSchemaLinkedAccount, optional) — Linked account - `product_alias` (string, optional) — Product alias - `product_description` (string, optional) — Product Description - `initial_balance` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Initial balance of the loan - `outstanding_balance` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Outstanding balance of the loan - `next_payment_amount` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Next payment amount - `begin_date` (date, optional) — Loan start date - `renovation_date` (date, optional) — Renovation Date - `end_date` (date, optional) — Loan expected end date - `next_payment_date` (date, optional) — Next payment date - `interest_rate` (infonite__pydantic__fields__common___Rate__2, optional) — Loan interest rate - `current_period` (integer, optional) — Current period - `pending_periods` (integer, optional) — Pending periods - `total_periods` (integer, optional) — Total periods ### SepaDirectDebitSchemaAccount The customer's account the debit is charged to. - `type`: `clabe` (CLABE) - `control_digits` (string, required) — Control digit - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial Clabe - `value` (string, required) — Clave Bancaria Estandarizada - `type`: `generic` (Generic Identifier) - `value` (string, required) — Identifier - `control_digits` (string, optional) — Control digits - `entity_code` (string, optional) — Entity code - `entity_country` (string, optional) — Entity country - `entity_office` (string, optional) — Entity office - `type`: `iban` (IBAN) - `control_digits` (string, required) — Control digits - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial IBAN - `value` (string, required) — International Bank Account Number ### BeneficiarySchema Who collects the debit. - `identifier` (string, optional) — Beneficiary identifier, as the bank reports it. - `name` (string, optional) — Beneficiary name. - `account` (BeneficiarySchemaAccount, optional) — Account the beneficiary collects into, when the bank discloses it. - `tax_id` (string, optional) — Beneficiary tax ID, when the bank discloses it. ### PayerSchema Who pays the debit. - `name` (string, optional) — Payer name. - `identifier` (string, optional) — Payer identifier, as the bank reports it. ### DirectDebitTransactionSchema One charge of the direct debit: when it was issued and paid, and for how much. - `status` (enum, required) — Status of this charge. - Allowed values: `unknown`, `pending`, `booked`, `cancelled`, `failed`, `reversed` - `issue_date` (string, optional) — Date the charge was issued. - `payment_date` (string, optional) — Date the charge was paid. - `concept` (string, optional) — Concept of the charge, as the bank reports it. - `amount` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Amount of the charge. ### FileAttachmentSchema A document attached to a result — an official report, a receipt, an invoice... The entry describes the file; its bytes are downloaded with `id`, through the attachments endpoint of the API that returned the result. - `sub_family` (enum, required) — What kind of document this is (e.g. `attachment:es-tgss-life-report`). - Allowed values: `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`, `attachment:person-certified-photo` - `id` (string, required) — Attachment identifier — what the attachments endpoint of the API that returned the result takes to download the file. - `content_name` (string, required) — File name of the document. - `content_type` (string, required) — MIME type of the content. - `metadata` (map from string to any, required) — Extra facts about the document, as simple key-value pairs (e.g. its official verification code, its issue date). - `product` ("attachment", optional, default: attachment) — The product type identifier. Always `attachment`. - `content_hash` (string, optional) — Fingerprint of the content, to verify its integrity. ### IdentificationNumberSchema One identification document: its type, its value, and whether the value passed validation. - `type` (enum, required) — Kind of document the number belongs to (e.g. a national ID, passport, tax ID, or Social Security number). - Allowed values: `unknown`, `es:dni`, `es:nie`, `es:cif`, `es:ssn`, `co:cc`, `co:ce`, `co:nit`, `co:ti` - `value` (string, required) — The number itself, as reported by the source. - `validated` (boolean, required) — 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` (string, optional, nullable) — Country that issued the number, as a two-letter ISO code. - `valid_until` (date, optional) — Expiry date of the document, when the source reports it. ### AddressSchema 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` (string, optional, nullable) — Free label for the address (e.g. `Headquarter`, `Domicilio`). - `street` (string, optional, nullable) — Street line: name and number. - `street_extra` (string, optional, nullable) — Second street line: floor, suite, staircase, apartment... - `municipality` (string, optional, nullable) — Municipality the address belongs to. - `city` (string, optional, nullable) — City or town. - `state` (string, optional, nullable) — State or province code. - `country` (string, optional, nullable) — Country, as a two-letter ISO code. - `zip_code` (string, optional, nullable) — Postal code. ### EntitySchema - `name` (string, optional) — Name - `code` (string, optional) — Code - `country_code` (string, optional) — Country Code - `identifier` (IdentificationNumberSchema, optional) — Holder identifier ### InfoniteSchemasUtilsCurrencyAmountSchema1Currency Three-letter ISO currency code — or `***` when the source did not disclose the currency. - string - "***" ### PanIdentifierSchema Primary Account Number - `type` ("pan", required) - `masked` (string, required) — Partial PAN - `brand` (enum, optional) — Card brand - Allowed values: `American Express`, `Mastercard`, `Visa`, `Mir`, `Maestro`, `Discover`, `Verve`, `Dankort`, `Troy`, `UnionPay`, `JCB`, `Diners Club`, `other` ### CreditCardSchemaLinkedAccount Linked account, if proceeds - IBAN: IBAN - CLABE: CLABE - Generic Identifier: Generic Identifier ### CardTransactionSchema - `type` (enum, required) — Transaction type - Allowed values: `unknown`, `opening`, `closure`, `credit`, `debit`, `default` - `status` (enum, required) — Transaction status - Allowed values: `unknown`, `pending`, `booked`, `cancelled`, `failed`, `reversed` - `value_date` (date, optional) — 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` (infonite__schemas__utils__CurrencyAmountSchema__1, optional) — Transaction amount - `descriptions` (list of string, optional) — Original transaction descriptions - `provider_id` (string, optional) — Unique ID for the transaction in the provider system - `merchant` (EntitySchema, optional) — Merchant information, if available ### DebitCardSchemaLinkedAccount Linked account, if proceeds - IBAN: IBAN - CLABE: CLABE - Generic Identifier: Generic Identifier ### PrepaidCardSchemaLinkedAccount Linked account, if proceeds - IBAN: IBAN - CLABE: CLABE - Generic Identifier: Generic Identifier ### TimeDepositSchemaAccount Deposit Account - IBAN: IBAN - CLABE: CLABE - Generic Identifier: Generic Identifier ### Generic Identifier Generic account identifier - `value` (string, required) — Identifier - `entity_country` (string, optional) — Entity country - `entity_code` (string, optional) — Entity code - `entity_office` (string, optional) — Entity office - `control_digits` (string, optional) — Control digits ### infonite__pydantic__fields__common___Rate__1 - `value` (string, optional, default: NaN) — Decimal number with 2 digits precision - `unit` (InfonitePydanticFieldsCommonRate1Unit, optional, default: %) - `description` (string, optional, nullable) ### SavingsGoalSchemaAccount Deposit Account - IBAN: IBAN - CLABE: CLABE - Generic Identifier: Generic Identifier ### InvestmentAccountSchemaIdentifier Account identifier - `type`: `clabe` (CLABE) - `control_digits` (string, required) — Control digit - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial Clabe - `value` (string, required) — Clave Bancaria Estandarizada - `type`: `generic` (Generic Identifier) - `value` (string, required) — Identifier - `control_digits` (string, optional) — Control digits - `entity_code` (string, optional) — Entity code - `entity_country` (string, optional) — Entity country - `entity_office` (string, optional) — Entity office - `type`: `iban` (IBAN) - `control_digits` (string, required) — Control digits - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial IBAN - `value` (string, required) — International Bank Account Number ### InvestmentStockSchemaAccount Account identifier - `type`: `clabe` (CLABE) - `control_digits` (string, required) — Control digit - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial Clabe - `value` (string, required) — Clave Bancaria Estandarizada - `type`: `generic` (Generic Identifier) - `value` (string, required) — Identifier - `control_digits` (string, optional) — Control digits - `entity_code` (string, optional) — Entity code - `entity_country` (string, optional) — Entity country - `entity_office` (string, optional) — Entity office - `type`: `iban` (IBAN) - `control_digits` (string, required) — Control digits - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial IBAN - `value` (string, required) — International Bank Account Number ### infonite__schemas__utils__CurrencyAmountSchema__2 - `currency` (InfoniteSchemasUtilsCurrencyAmountSchema2Currency, required) — Three-letter ISO currency code — or `***` when the source did not disclose the currency. - `amount` (string, optional, default: nan) — Decimal number with 6 digits precision ### infonite__pydantic__fields__common___Rate__2 - `value` (string, optional, default: NaN) — Decimal number with 6 digits precision - `unit` (InfonitePydanticFieldsCommonRate2Unit, optional, default: %) - `description` (string, optional, nullable) ### InvestmentFundSchemaAccount Account identifier - `type`: `clabe` (CLABE) - `control_digits` (string, required) — Control digit - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial Clabe - `value` (string, required) — Clave Bancaria Estandarizada - `type`: `generic` (Generic Identifier) - `value` (string, required) — Identifier - `control_digits` (string, optional) — Control digits - `entity_code` (string, optional) — Entity code - `entity_country` (string, optional) — Entity country - `entity_office` (string, optional) — Entity office - `type`: `iban` (IBAN) - `control_digits` (string, required) — Control digits - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial IBAN - `value` (string, required) — International Bank Account Number ### PensionPlanSchemaIdentifier Plan number - `type`: `generic` (Generic Identifier) - `value` (string, required) — Identifier - `control_digits` (string, optional) — Control digits - `entity_code` (string, optional) — Entity code - `entity_country` (string, optional) — Entity country - `entity_office` (string, optional) — Entity office ### PensionPlanSchemaLinkedAccount Account identifier - `type`: `clabe` (CLABE) - `control_digits` (string, required) — Control digit - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial Clabe - `value` (string, required) — Clave Bancaria Estandarizada - `type`: `generic` (Generic Identifier) - `value` (string, required) — Identifier - `control_digits` (string, optional) — Control digits - `entity_code` (string, optional) — Entity code - `entity_country` (string, optional) — Entity country - `entity_office` (string, optional) — Entity office - `type`: `iban` (IBAN) - `control_digits` (string, required) — Control digits - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial IBAN - `value` (string, required) — International Bank Account Number ### infonite__schemas__utils__CurrencyAmountSchema__3 - `currency` (InfoniteSchemasUtilsCurrencyAmountSchema3Currency, required) — Three-letter ISO currency code — or `***` when the source did not disclose the currency. - `amount` (string, optional, default: nan) — Decimal number with 6 digits precision ### infonite__schemas__utils__CurrencyAmountSchema__4 - `currency` (InfoniteSchemasUtilsCurrencyAmountSchema4Currency, required) — Three-letter ISO currency code — or `***` when the source did not disclose the currency. - `amount` (string, optional, default: nan) — Decimal number with 6 digits precision ### PersonalLoanSchemaLinkedAccount Linked account - IBAN: IBAN - CLABE: CLABE - Generic Identifier: Generic Identifier ### MortgageSchemaLinkedAccount Linked account - IBAN: IBAN - CLABE: CLABE - Generic Identifier: Generic Identifier ### BeneficiarySchemaAccount Account the beneficiary collects into, when the bank discloses it. - `type`: `clabe` (CLABE) - `control_digits` (string, required) — Control digit - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial Clabe - `value` (string, required) — Clave Bancaria Estandarizada - `type`: `generic` (Generic Identifier) - `value` (string, required) — Identifier - `control_digits` (string, optional) — Control digits - `entity_code` (string, optional) — Entity code - `entity_country` (string, optional) — Entity country - `entity_office` (string, optional) — Entity office - `type`: `iban` (IBAN) - `control_digits` (string, required) — Control digits - `entity_code` (string, required) — Bank code - `entity_country` (string, required) — Bank Country - `entity_office` (string, required) — Bank office - `masked` (string, required) — Partial IBAN - `value` (string, required) — International Bank Account Number ### IBAN International Bank Account Number - `value` (string, required) — International Bank Account Number - `masked` (string, required) — Partial IBAN - `entity_country` (string, required) — Bank Country - `entity_code` (string, required) — Bank code - `entity_office` (string, required) — Bank office - `control_digits` (string, required) — Control digits ### CLABE Clave Bancaria Estandarizada - `value` (string, required) — Clave Bancaria Estandarizada - `masked` (string, required) — Partial Clabe - `entity_country` (string, required) — Bank Country - `entity_code` (string, required) — Bank code - `entity_office` (string, required) — Bank office - `control_digits` (string, required) — Control digit ### InfonitePydanticFieldsCommonRate1Unit - "%" - string ### InfoniteSchemasUtilsCurrencyAmountSchema2Currency Three-letter ISO currency code — or `***` when the source did not disclose the currency. - string - "***" ### InfonitePydanticFieldsCommonRate2Unit - "%" - string ### InfoniteSchemasUtilsCurrencyAmountSchema3Currency Three-letter ISO currency code — or `***` when the source did not disclose the currency. - string - "***" ### InfoniteSchemasUtilsCurrencyAmountSchema4Currency Three-letter ISO currency code — or `***` when the source did not disclose the currency. - string - "***"