Wealth Reader · Schema
entity-data
Bank AggregationOpen BankingPSD2Financial DataAccount AggregationInvestment PortfoliosWealth ManagementBankingFintechData Aggregation
Properties
| Name | Type | Description |
|---|---|---|
| success | boolean | |
| payload | object | |
| statistics | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/wealth-reader/main/json-schema/wealth-reader-entity-data-schema.json",
"title": "entity-data",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/wealth-reader-advanced-api-openapi.yml#/components/schemas/entity-data",
"type": "object",
"required": [
"success",
"payload",
"statistics"
],
"properties": {
"success": {
"type": "boolean"
},
"payload": {
"type": "object",
"properties": {
"user_information": {
"$ref": "#/$defs/user_information"
},
"portfolios": {
"$ref": "#/$defs/portfolios"
},
"accounts": {
"$ref": "#/$defs/accounts"
},
"cards": {
"$ref": "#/$defs/cards"
},
"receipts": {
"$ref": "#/$defs/receipts"
},
"loans": {
"$ref": "#/$defs/loans"
},
"deposits": {
"$ref": "#/$defs/deposits"
},
"leases": {
"$ref": "#/$defs/leases"
},
"insurances": {
"$ref": "#/$defs/insurances"
},
"properties": {
"$ref": "#/$defs/properties"
},
"files": {
"$ref": "#/$defs/files"
},
"contracts": {
"$ref": "#/$defs/contracts"
},
"factoring": {
"$ref": "#/$defs/factoring"
},
"confirming": {
"$ref": "#/$defs/confirming"
},
"employment": {
"$ref": "#/$defs/employment"
},
"guarantees": {
"$ref": "#/$defs/guarantees"
}
}
},
"statistics": {
"$ref": "#/$defs/statistics"
}
},
"$defs": {
"accounts": {
"type": "array",
"items": {
"type": "object",
"description": "Bank accounts",
"required": [
"uuid",
"code",
"name",
"currency",
"owners",
"balances",
"transactions"
],
"properties": {
"uuid": {
"type": "string"
},
"subtype": {
"type": "string",
"enum": [
"checking",
"savings",
"line-of-credit"
]
},
"interest_rate": {
"type": [
"number",
"null"
],
"description": "Account interest rate, if applicable."
},
"line_of_credit_details": {
"type": [
"object",
"null"
],
"description": "Specific details for line of credit accounts. Only available when subtype is line-of-credit",
"properties": {
"credit_limit": {
"type": [
"number",
"null"
],
"description": "Credit limit"
},
"interest_rate": {
"type": [
"number",
"null"
],
"description": "Interest rate for the credit line"
},
"credit_used": {
"type": "number",
"description": "Credit used"
},
"credit_available": {
"type": [
"number",
"null"
],
"description": "Available credit"
},
"constitution_date": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Date when the credit line was constituted"
},
"expiration_date": {
"type": [
"string",
"null"
],
"format": "date",
"description": "Expiration date of the credit line"
}
}
},
"code": {
"type": "string",
"description": "IBAN code without spaces"
},
"name": {
"type": "string"
},
"currency": {
"type": "string"
},
"owners": {
"$ref": "#/$defs/owners"
},
"balances": {
"type": "object",
"properties": {
"available": {
"type": "number"
},
"current": {
"type": "number"
}
}
},
"additional_info": {
"$ref": "#/$defs/additional_info"
},
"transactions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "Unique identifier, in relation to the account uuid, assigned by Wealth Reader"
},
"operation_date": {
"type": "string",
"format": "date"
},
"value_date": {
"type": "string",
"format": "date"
},
"amount": {
"type": "number"
},
"balance": {
"type": "number"
},
"description": {
"type": "string"
},
"pdf_file": {
"type": "string",
"description": "PDF file encoded in Base64 if requested via the add_pdf_from_uuids parameter"
},
"pdf_file_settled": {
"type": "boolean",
"description": "Indicates whether the file generated by the bank is final (true) or provisional (false)"
},
"categorization": {
"type": "object",
"description": "Optional categorization information",
"x-nullable": true,
"properties": {
"type": {
"type": "integer",
"description": "The complete list of categories can be obtained from the /entities/category-types/ method"
},
"portfolio-uuid": {
"type": "string",
"x-nullable": true
},
"ISIN": {
"type": "string",
"x-nullable": true
}
}
},
"transfer_details": {
"type": "object",
"x-nullable": true,
"description": "This data only appears when the transaction is a transfer. If it is a transfer and this information does not appear, but it does appear in online banking, you can open a ticket to have it added.",
"properties": {
"concept": {
"type": "string",
"description": "Concept written by the sender or issuer"
},
"sender_receiver": {
"type": "string",
"description": "Name of the sender or recipient"
},
"account_number": {
"type": "string",
"description": "Account number of the sender or recipient"
}
}
},
"additional_info": {
"$ref": "#/$defs/additional_info"
}
}
}
}
}
}
},
"additional_info": {
"type": "array",
"items": {
"type": "object",
"description": "Contains bank-specific fields with the name assigned by the bank",
"properties": {
"key": {
"type": "string",
"description": "Key of the additional information"
},
"value": {
"type": "string",
"description": "Value of the additional information"
}
}
}
},
"cards": {
"type": "array",
"items": {
"type": "object",
"description": "Credit, debit, and prepaid cards",
"required": [
"subtype",
"uuid",
"code",
"name",
"currency",
"balances"
],
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"inactive",
"cancelled",
"locked"
]
},
"subtype": {
"type": "string",
"enum": [
"credit",
"debit",
"prepaid"
]
},
"uuid": {
"type": "string"
},
"code": {
"type": "string",
"description": "Numbering with PCI compliance obfuscation"
},
"name": {
"type": "string"
},
"currency": {
"type": "string"
},
"next_payment_date": {
"type": "string",
"format": "date",
"description": "Next payment date for credit cards"
},
"anual_interest": {
"type": "number",
"description": "Annual interest rate"
},
"tae": {
"type": "number",
"description": "Annual Equivalent Rate (APR)"
},
"balances": {
"type": "object",
"properties": {
"available": {
"type": "number"
},
"limit": {
"type": "number"
},
"disposed": {
"type": "number"
}
}
},
"linked_account": {
"type": "string"
},
"owner": {
"$ref": "#/$defs/owners"
},
"additional_info": {
"$ref": "#/$defs/additional_info"
},
"transactions": {
"type": "array",
"items": {
"type": "object",
"required": [
"uuid",
"value_date",
"amount",
"description"
],
"properties": {
"uuid": {
"type": "string"
},
"settled": {
"type": "boolean",
"description": "Indicates whether it is a transaction settled by the bank, which means it will not change in subsequent readings."
},
"operation_date": {
"type": "string",
"format": "date",
"description": "Transaction operation date"
},
"value_date": {
"type": "string",
"format": "date"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string",
"description": "Transaction currency"
},
"exchange_rate": {
"type": "number",
"description": "Exchange rate applied to the transaction"
},
"description": {
"type": "string"
},
"categorization": {
"type": [
"object",
"null"
],
"description": "Categorization information if available",
"properties": {
"type": {
"type": "integer",
"description": "Category type according to the /entities/category-types/ method"
}
}
},
"additional_info": {
"$ref": "#/$defs/additional_info"
}
}
}
}
}
}
},
"confirming": {
"type": "array",
"items": {
"type": "object",
"description": "Confirming contracts",
"properties": {
"uuid": {
"type": "string"
},
"contract_number": {
"type": "string"
},
"name": {
"type": "string"
},
"currency": {
"type": "string"
},
"balances": {
"type": "object",
"properties": {
"available": {
"type": "number"
},
"disposed": {
"type": "number"
},
"limit": {
"type": "number"
}
}
},
"interest_rate": {
"type": "number"
},
"linked_account": {
"type": "string"
},
"next_payment_date": {
"type": "string"
},
"number_invoices": {
"type": "integer"
},
"total_value": {
"type": "number",
"description": "Total value of invoices"
},
"total_advanced_value": {
"type": "number",
"description": "Total advanced value"
},
"deferrals": {
"type": "array",
"description": "Validated confirming deferral rows. May be present when one status result failed; totals are then omitted.",
"items": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "string",
"enum": [
"paid",
"unpaid"
]
},
"overdue": {
"type": "boolean",
"description": "Present as true for Impagado deferrals"
},
"start_date": {
"type": "string",
"format": "date"
},
"due_date": {
"type": "string",
"format": "date"
},
"total_value": {
"type": "number"
},
"deferred_value": {
"type": "number"
},
"interest_value": {
"type": "number"
},
"interest_rate": {
"type": "number"
},
"late_fees": {
"type": "number"
}
}
}
},
"deferrals_summary": {
"type": "object",
"description": "Present only when all requested deferral statuses completed successfully.",
"properties": {
"count": {
"type": "integer"
},
"total_value": {
"type": "number"
},
"deferred_value": {
"type": "number"
},
"interest_value": {
"type": "number"
},
"late_fees": {
"type": "number"
}
}
},
"providers": {
"type": "array",
"description": "List of providers associated with the confirming contract",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "Unique identifier for the provider"
},
"company_id": {
"type": "string",
"description": "Company tax identification number"
},
"company_name": {
"type": "string",
"description": "Company name"
}
}
}
},
"invoices": {
"type": "array",
"description": "List of invoices associated with the confirming contract",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "Unique identifier for the invoice"
},
"invoice_id": {
"type": "string",
"description": "Invoice number or reference"
},
"provider_id": {
"type": "string",
"description": "Provider tax identification number"
},
"operation_date": {
"type": "string",
"format": "date",
"description": "Date when the invoice was processed"
},
"due_date": {
"type": "string",
"format": "date",
"description": "Invoice due date"
},
"amount": {
"type": "number",
"description": "Invoice amount"
},
"status": {
"type": "string",
"description": "Invoice status (e.g., pending, advanced, paid)"
},
"additional_info": {
"$ref": "#/$defs/additional_info"
}
}
}
},
"additional_info": {
"$ref": "#/$defs/additional_info"
}
}
}
},
"contracts": {
"type": "array",
"items": {
"type": "object",
"description": "Contracts associated with the user, such as loans, cards, or insurance.",
"required": [
"signing_date",
"type",
"subtype",
"description",
"pdf_file"
],
"properties": {
"signing_date": {
"type": "string",
"format": "date",
"description": "Contract signing date."
},
"type": {
"type": "string",
"enum": [
"loan",
"card",
"insurance"
],
"description": "Contract type"
},
"subtype": {
"type": "string",
"enum": [
"personal",
"mortgage",
"card",
"health",
"life",
"auto"
],
"description": "Contract subtype"
},
"description": {
"type": "string",
"description": "Description provided by the bank"
},
"pdf_file": {
"type": "string",
"format": "byte",
"description": "Contract PDF file encoded in base64"
}
}
}
},
"deposits": {
"type": "array",
"items": {
"type": "object",
"description": "Fixed-term deposits",
"required": [
"uuid",
"code",
"name",
"currency",
"principal",
"start_date",
"maturity_date",
"rate_type",
"nominal_interest_rate",
"owners",
"status",
"interest_movements"
],
"properties": {
"uuid": {
"type": "string",
"description": "Unique identifier, in relation to the user, assigned by Wealth Reader"
},
"code": {
"type": "string",
"description": "Bank's internal identifier (contract/deposit)"
},
"name": {
"type": "string"
},
"currency": {
"type": "string"
},
"principal": {
"type": "number",
"description": "Contracted nominal amount"
},
"pending_principal": {
"type": "number",
"description": "Remaining nominal amount to be repaid"
},
"start_date": {
"type": "string",
"format": "date"
},
"maturity_date": {
"type": "string",
"format": "date"
},
"payment_frequency": {
"type": "string",
"enum": [
"monthly",
"quarterly",
"semiannual",
"annual",
"at_maturity"
],
"description": "Interest payment frequency, if provided by the entity"
},
"capitalization": {
"type": "string",
"enum": [
"none",
"simple",
"compound"
],
"description": "Interest capitalization type:\n* `none` - Interest is paid out to linked_account, principal stays constant\n* `simple` - Interest calculated on original principal only, may accrue (accrued_interest) but does not generate further interest\n* `compound` - Interest added to principal at each period, next period's interest calculated on the new total\n"
},
"rate_type": {
"type": "string",
"enum": [
"fixed",
"variable"
]
},
"nominal_interest_rate": {
"type": "number",
"description": "Nominal interest rate (NIR) for the entire period, if applicable"
},
"apr_tae": {
"type": "number",
"description": "Annual Percentage Rate (APR/TAE); if the entity provides TAE, return it here"
},
"day_count_convention": {
"type": "string",
"enum": [
"ACT/360",
"ACT/365",
"30E/360",
"ACT/ACT"
],
"description": "Day count convention, if available"
},
"linked_account": {
"type": "string",
"description": "IBAN where interests or principal are credited at maturity"
},
"accrued_interest": {
"type": "number",
"description": "Accrued unpaid interest as of the extraction date"
},
"expected_interest_total": {
"type": "number",
"description": "Expected gross interest at maturity (if the entity calculates it)"
},
"withholding_tax_rate": {
"type": "number",
"description": "Withholding tax rate applied to interest, if reported by the entity"
},
"status": {
"type": "string",
"enum": [
"active",
"matured",
"cancelled",
"early_redeemed"
]
},
"auto_renewal": {
"type": "object",
"description": "Auto-renewal information",
"properties": {
"enabled": {
"type": "boolean"
},
"renewed_times": {
"type": "integer"
},
"next_renewal_date": {
"type": [
"string",
"null"
],
"format": "date"
},
"renewal_term_months": {
"type": [
"integer",
"null"
]
}
}
},
"early_withdrawal": {
"type": "object",
"description": "Early withdrawal clauses (if reported by the entity)",
"properties": {
"allowed": {
"type": "boolean"
},
"penalty_type": {
"type": "string",
"enum": [
"percentage",
"fixed",
"interest_loss",
"other"
]
},
"penalty_value": {
"type": "number"
},
"notes": {
"type": "string"
}
}
},
"owners": {
"$ref": "#/$defs/owners"
},
"interest_movements": {
"type": "array",
"description": "Interest payments made and/or scheduled",
"items": {
"type": "object",
"required": [
"date",
"currency",
"gross_interest"
],
"properties": {
"uuid": {
"type": "string",
"description": "Unique identifier, in relation to the deposit"
},
"scheduled": {
"type": "boolean",
"description": "true if scheduled (future), false if already paid"
},
"date": {
"type": "string",
"format": "date"
},
"period_start": {
"type": "string",
"format": "date",
"description": "Start of the period to which the coupon/interest corresponds"
},
"period_end": {
"type": "string",
"format": "date"
},
"currency": {
"type": "string"
},
"gross_interest": {
"type": "number"
},
"withholding_tax": {
"type": "number"
},
"net_interest": {
"type": "number"
},
"payment_type": {
"type": "string",
"enum": [
"coupon",
"maturity"
]
}
}
}
},
"principal_movements": {
"type": "array",
"description": "Principal movements - opening, renewal, cancellation, reimbursement",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "Unique identifier, in relation to the deposit"
},
"date": {
"type": "string",
"format": "date"
},
"type": {
"type": "string",
"enum": [
"opening",
"renewal",
"maturity_payout",
"early_redemption"
]
},
"amount": {
"type": "number",
"minimum": 0,
"description": "It is always an absolute value. The sign is defined by type"
},
"currency": {
"type": "string"
},
"target_account": {
"type": "string",
"description": "Destination account when principal is reimbursed"
}
}
}
}
}
}
},
"employment": {
"type": "object",
"description": "Employment history / work life and contributions",
"properties": {
"summary": {
"type": "object",
"description": "Aggregated summary of employment history",
"properties": {
"totalDaysRegistered": {
"type": "integer",
"description": "Total days registered"
},
"daysInMultipleActivity": {
"type": "integer",
"description": "Days in multiple activity"
},
"daysContributedForBenefits": {
"type": "integer",
"description": "Days contributed for benefits"
},
"totalTimeEquivalence": {
"type": "string",
"description": "Total time equivalence"
}
}
},
"periods": {
"type": "array",
"description": "List of employment and similar periods (employment, unemployment, self-employment, etc.)",
"items": {
"type": "object",
"required": [
"employer",
"regime",
"contract",
"category",
"actualStartDate",
"startDate",
"endDate",
"contributedDays"
],
"properties": {
"employer": {
"type": "string"
},
"regime": {
"type": "string"
},
"contract": {
"type": "string"
},
"category": {
"type": "string"
},
"actualStartDate": {
"type": "string",
"format": "date"
},
"startDate": {
"type": "string",
"format": "date"
},
"endDate": {
"type": "string",
"description": "End date or 'Actual' if the period is ongoing"
},
"contributedDays": {
"type": "integer",
"description": "Days contributed within the period"
}
}
}
}
}
},
"factoring": {
"type": "array",
"items": {
"type": "object",
"description": "Factoring contracts",
"properties": {
"uuid": {
"type": "string"
},
"contract_number": {
"type": "string"
},
"name": {
"type": "string"
},
"assignor_id": {
"type": "string",
"description": "Assignor tax identification number (NIF)"
},
"assignor": {
"type": "string",
"description": "Assignor name. The user or company that sells invoices to obtain liquidity."
},
"assignor_type": {
"type": "string",
"description": "Type of factoring agreement",
"enum": [
"non-recourse-factor",
"recourse-factor"
]
},
"assignee": {
"type": "string",
"description": "Assignee name. The banking or financial institution that acquires the collection rights."
},
"currency": {
"type": "string"
},
"balances": {
"type": "object",
"properties": {
"available": {
"type": "number"
},
"disposed": {
"type": "number"
},
"limit": {
"type": "number"
}
}
},
"interest_rate": {
"type": "number"
},
"linked_account": {
"type": "string",
"description": "IBAN code without spaces. The value will be null when the entity does not provide it."
},
"next_payment_date": {
"type": "string"
},
"number_invoices": {
"type": "integer"
},
"total_value": {
"type": "number",
"description": "Total value of invoices"
},
"total_advanced_value": {
"type": "number",
"description": "Total advanced value"
},
"clients": {
"type": "array",
"description": "List of clients associated with the factoring contract",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"description": "Unique identifier for the client"
},
"client_id": {
"type": "st
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wealth-reader/refs/heads/main/json-schema/wealth-reader-entity-data-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/wealth-reader-entity-data"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.