Wealth Reader (8.1.3)

Download OpenAPI specification:

Regulatoriske API'er baseret på PSD2 giver adgang til visse finansielle oplysninger såsom banksaldi og transaktioner. Der findes dog andre kilder til formueoplysninger, der ikke er tilgængelige gennem disse API'er. Wealth Reader API udvider de oplysninger, der tilbydes af regulatoriske API'er, ved at give realtidstilgang til yderligere formuekilder i enhver enhed verden over. Der findes to andre relaterede dokumenter, der vil hjælpe dig med at integrere Wealth Reader API. Den ene er Javascript widget integrationsguiden: https://docs-en.wealthreader.com/ og den anden er en Postman samling baseret på denne dokumentation. Meget vigtigt: Denne API-definition er tilpasset kunder, der integrerer via Widget, så nogle parametre, der ikke er nødvendige for denne type integration, er udeladt, såsom bankgodkendelsesparametre, da et token vil blive brugt.

Core

Kærne-API påkrævet til standardintegrationer

Henter finansielle aktiver og detaljer om deres sammensætning

Henter finansielle aktiver og detaljer om deres sammensætning inklusive investeringsporteføljer sammensat af aktier eller fonde, kreditkort, forsikringer og lån. Inkluderer ejerskabsoplysninger for hver aktiv samt unikke identifikatorer, der letter databehandling. Det er muligt at få Mock-data. Tjek med det tekniske team hvordan dette gøres.

Request Body schema: application/x-www-form-urlencoded

api_key	string Identificerer klienten i tjenesten
code	string Navn på enheden. Den komplette liste er tilgængelig med GET
token	string Identificerer de opbevarede legitimationsoplysninger. Flowet, hvormed tokenet blev opnået, er beskrevet i dokumentet 'Widget integrationsvejledning'. Følgende Mock-brugere er tilgængelige: MOCKDATA, OK-svar; MOCKOTP, svar med OTP-udfordring; MOCKLOGINKO, svar med login-fejl
product_types	string Enum: "accounts" "portfolios" "cards" "receipts" "loans" "factoring" "confirming" "properties" "invoices" "files" Liste over produkttyper, hvorfra information skal hentes. Accepterer flere værdier adskilt med kommaer.
only_balances	boolean Default: false Angiver, om der kun skal hentes saldi for produkterne i stedet for al tilgængelig information. Standardværdi: false.
date_from	string <date> Dato fra hvilken transaktioner anmodes om, i ÅÅÅÅ-MM-DD format. Skal være en dato før i dag.
date_to	string <date> Dette gælder kun for begrænsning efter fremtidige datoer for produkterne loan og confirming, i ÅÅÅÅ-MM-DD format. Datoen skal være senere end i dag
required_products_schema	string Påkrævet produktskema. Angiver de konti eller kort, hvorfra data ønskes, med yderligere konfigurationer.
add_pdf_from_uuids	string Accepterer transaktions-uuid'er adskilt med kommaer. Parameter, der kun tages i betragtning, hvis product_types er ALL eller inkluderer accounts. Tilføjer PDF-dokumentet tilknyttet hver af de anmodede banktransaktioner.

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

api_key=12345678&code=caixabank&token=MOCKDATA&product_types=accounts%2Cportfolios&date_from=2024-01-01

Response samples

Content type

application/json

[{"success": true,
"payload": {"user_information": {"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"gender": "male",
"birth_date": "1980-09-26",
"birth_place": "Ibiza",
"email": "[email protected]",
"cell_phone": "+34666123456",
"address": "CALLE BAILEN 41 1A",
"city": "MADRID",
"country": "SPAIN",
"postal_code": "28005",
"marital_status": "married",
"job": "CUENTA PROPIA"
},
"portfolios": [{"subtype": "funds",
"uuid": "05e4563f5bbf2d06efd0a29ebe7edbbb4e1bff63",
"code": "1465010091400123456789",
"name": "Fondo Dinámico",
"currency": "EUR",
"total_value": 3275.6,
"weighted_return": 8.49,
"annualized_volatility": 0,
"yield": 256.27,
"contributions": 3019.33,
"withholdings": 0,
"contracting_date": "2016-04-27",
"linked_account": "ES4021005321592566566159",
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"composition": {"currency": "EUR",
"weighting": 100,
"shares": 225.0077,
"price": 14.5577,
"total_amount": 3275.6
},
"transactions": [{"uuid": "05e4563f5bbf2d06efd0a29ebe7edbbb4e1bff63",
"operation_pending": false,
"operation_date": "2020-01-30",
"value_date": "2020-01-30",
"operation_type": "purchase",
"shares": 1076.8273,
"price": 11.1438,
"total_amount": 12000,
"reference_currency": "EUR",
"currency": "EUR",
"exchange_rate": 1
}
]
}
],
"bonds": [{"uuid": "b8e42d60e6e8d3a5efb0b2a8e4e0b1a4b5c5d6e7",
"name": "Bono del Estado Español 2025",
"isin": "ES00000123E5",
"currency": "EUR",
"total_value": 5000,
"interest_rate": 1.75,
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"maturity_date": "2025-10-15",
"issuer": "Gobierno de España",
"principal": 1000,
"coupon_payment_dates": ["2023-04-15",
"2023-10-15"
],
"credit_rating": "AAA",
"yield_to_maturity": 2.5,
"current_yield": 2,
"callability": "Callable a partir del 2024-01-01",
"type_of_bond": "government"
}
],
"accounts": [{"uuid": "8076932f04f73e27fe608fee4d12fca8708dec8c",
"subtype": "checking",
"interest_rate": 0.5,
"line_of_credit_details": {"credit_limit": 50000,
"interest_rate": 4.5,
"credit_used": 15000,
"credit_available": 35000,
"constitution_date": "2021-05-20",
"expiration_date": "2031-05-20"
},
"code": "ES4914651234561234567890",
"name": "Cuenta NÓMINA",
"currency": "EUR",
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"balances": {"available": 14302.07,
"current": 14302.07
},
"additional_info": [{"key": "string",
"value": "string"
}
],
"transactions": [{"uuid": "d0c2ea4c072cf4d7b0fd494d7728260d736e6b25",
"operation_date": "2022-12-30",
"value_date": "2022-12-30",
"amount": -1.1,
"balance": 14302.07,
"description": "Pago en TELPARK MADRID ES",
"pdf_file": "string",
"pdf_file_final": true,
"categorization": {"type": 1,
"portfolio-uuid": "1465010091400123456789",
"ISIN": "US88160R1014"
},
"transfer_details": {"concept": "Pago de factura 12345",
"sender_receiver": "Juan Pérez",
"account_number": "ESXX12341234121234567890"
},
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"cards": [{"status": "active",
"subtype": "credit",
"uuid": "aefd89eade0a6a09d9b8eab4c22da6a6a37632e6",
"code": "516097********1234",
"name": "Credit Card",
"currency": "EUR",
"next_payment_date": "2023-01-05",
"anual_interest": 17.48,
"tae": 18.95,
"balances": {"available": 3980,
"limit": 4000,
"disposed": 20
},
"linked_account": "ES4021005321592566566159",
"owner": {"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
},
"additional_info": [{"key": "string",
"value": "string"
}
],
"transactions": [{"uuid": "78ceedca9cd9d2f2bfbb2439795ab6a1fcefc12b",
"settled": false,
"operation_date": "2022-12-28",
"value_date": "2022-12-28",
"amount": -20,
"currency": "EUR",
"exchange_rate": 1,
"description": "Pago en AMZN MKTP ES123CM0ZM4",
"categorization": {"type": 0
},
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"receipts": [{"last_receipt_date": "2023-07-23",
"issuer": "Canal de Isabel II",
"description": "RECIBO CONTRATO 328774628 FACTURA DEL 18 07 23",
"account": "ES0123456789012345678901",
"status": "paid",
"amount": 50.75,
"pdf_file": "string",
"pdf_file_settled": true
}
],
"loans": [{"contract_number": "9620.321-205439-70",
"loan_type": "Variable rate mortgage",
"constitution_date": "2022-02-23",
"currency": "EUR",
"granted_capital": 207000,
"pending_amount": 166639.77,
"next_installment": 1040.3,
"linked_account": "ES0123456789012345678901",
"holders": [{"id": "32945945D",
"name": "Diego Serrano"
}
],
"interest_rate": 3.768,
"expiration_date": "2042-03-01",
"pending_receipts": 223,
"amortization_made": [{"date": "2022-12-01",
"amortized": 515.43,
"interest": 524.87,
"total": 1040.3,
"pending_capital": 166639.77,
"operation_type": "receipt_paid"
}
],
"amortization_pending": [{"date": "2030-12-01",
"amortized": 515.43,
"interest": 524.87,
"total": 1040.3,
"pending_capital": 66639.77,
"operation_type": "receipt_scheduled"
}
]
}
],
"deposits": [{"uuid": "0ae4d722b1c82feeafb4b36b2893230444071335",
"code": "DPZ-1234567890",
"name": "12-month deposit",
"currency": "EUR",
"principal": 10000,
"pending_principal": 5000,
"start_date": "2024-09-01",
"maturity_date": "2025-09-01",
"payment_frequency": "at_maturity",
"capitalization": "none",
"rate_type": "fixed",
"nominal_interest_rate": 3,
"apr_tae": 3.04,
"day_count_convention": "ACT/365",
"linked_account": "ES4021005321592566566159",
"accrued_interest": 24.58,
"expected_interest_total": 300,
"withholding_tax_rate": 19,
"status": "active",
"auto_renewal": {"enabled": false,
"renewed_times": 0,
"next_renewal_date": "2019-08-24",
"renewal_term_months": 0
},
"early_withdrawal": {"allowed": true,
"penalty_type": "interest_loss",
"penalty_value": 100,
"notes": "Loss of accrued interest for the current period"
},
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"interest_movements": [{"uuid": "90763109952d4f2ebece8dceca8254078c5384a0",
"scheduled": false,
"date": "2025-09-01",
"period_start": "2024-09-01",
"period_end": "2025-09-01",
"currency": "EUR",
"gross_interest": 300,
"withholding_tax": 57,
"net_interest": 243,
"payment_type": "maturity"
}
],
"principal_movements": [{"date": "2019-08-24",
"type": "opening",
"amount": 12000,
"currency": "string",
"target_account": "string"
}
]
}
],
"leases": [{"subtype": "leasing",
"uuid": "1f0a0b1c2d3e4f5a6b7c8d9e0f1234567890abcd",
"contract_number": "L-2024-000123",
"name": "BMW 3 Series Leasing",
"provider": {"name": "Banco XYZ Renting, S.A.",
"tax_id": "A12345678"
},
"currency": "EUR",
"start_date": "2024-10-01",
"end_date": "2028-09-30",
"term_months": 48,
"payment_frequency": "monthly",
"status": "active",
"linked_account": "ES4021005321592566566159",
"holders": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"asset": {"category": "vehicle",
"description": "BMW 320d Touring",
"vin": "WBA8G51040K123456",
"license_plate": "1234-ABC",
"brand": "BMW",
"model": "320d",
"year": 2024,
"serial_number": "string",
"address": "string"
},
"financials": {"capital_financed": 35000,
"nominal_interest_rate": 4.25,
"apr_tae": 4.38,
"discount_rate": 0,
"initial_fee": 3000,
"security_deposit": 1000,
"residual_value": 12000,
"purchase_option": true,
"services_included": {"maintenance": true,
"insurance": true,
"roadside_assistance": true,
"tires": false
},
"vat_included": true,
"mileage_limit_year": 15000,
"early_termination": {"allowed": true,
"penalty_type": "percentage_of_remaining",
"penalty_value": 40
}
},
"totals": {"paid_installments": 10,
"remaining_installments": 38,
"total_paid": 0,
"total_pending": 0,
"principal_outstanding": 0,
"accrued_interest": 0
},
"installments": {"paid": [{"uuid": "b07a1a0d3e6f4c2a9e1d0f8b7c6a5e4d3c2b1a0f",
"date": "2025-01-01",
"status": "pending",
"currency": "EUR",
"total": 625.5,
"breakdown": {"principal": 450,
"interest": 80,
"services": 70,
"taxes": 25.5,
"fees": 0
},
"value_date": "2019-08-24",
"receipt_uuid": "string",
"additional_info": [{"key": null,
"value": null
}
]
}
],
"scheduled": [{"uuid": "b07a1a0d3e6f4c2a9e1d0f8b7c6a5e4d3c2b1a0f",
"date": "2025-01-01",
"status": "pending",
"currency": "EUR",
"total": 625.5,
"breakdown": {"principal": 450,
"interest": 80,
"services": 70,
"taxes": 25.5,
"fees": 0
},
"value_date": "2019-08-24",
"receipt_uuid": "string",
"additional_info": [{"key": null,
"value": null
}
]
}
]
}
}
],
"properties": [{"uuid": "string",
"code": "string",
"description": "string",
"purpose": "string",
"currency": "string",
"trading_price": 0,
"trading_year": 0,
"historic_prices": [{"date": "2019-08-24",
"price": 0
}
]
}
],
"files": [{"file_date": "2023-07-21",
"retrieval_type": "repository",
"file_type": "Norma 43",
"description": "Monthly account statement",
"content": "string"
}
],
"contracts": [{"signing_date": "2003-09-26",
"type": "loan",
"subtype": "mortgage",
"description": "Variable rate mortgage",
"pdf_file": "string"
}
],
"factoring": [{"uuid": "a62ae601a424403d0fbe968d335378421006c277",
"contract_number": "000117001234567",
"name": "FACTORING PPAL SIN RECURSO",
"currency": "EUR",
"balances": {"available": 11360.26,
"disposed": 0,
"limit": 11360.26
},
"interest_rate": 5.25,
"linked_account": "ES0700812345678987654321",
"next_payment_date": "",
"number_invoices": 8,
"total_value": 14495.28,
"total_advanced_value": 6919.29,
"providers": [{"uuid": "2ea19f8f8bcda4fa5e54e139852e0a7459d16b49",
"company_id": "A12345678",
"company_name": "EMPRESA 1 SA"
}
],
"invoices": [{"uuid": "6b556584df0721e5f0b27448247c9682a6470d11",
"invoice_id": "2023-53",
"provider_id": "A12345678",
"operation_date": "2023-10-25",
"due_date": "2024-01-24",
"amount": 918.45,
"status": "advanced",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"confirming": [{"uuid": "a62ae601a424403d0fbe968d335378421006c277",
"contract_number": "000117001234567",
"name": "CONFIRMING PPAL SIN RECURSO",
"currency": "EUR",
"balances": {"available": 11360.26,
"disposed": 0,
"limit": 11360.26
},
"interest_rate": 5.25,
"linked_account": "ES0700812345678987654321",
"next_payment_date": "",
"number_invoices": 8,
"total_value": 14495.28,
"total_advanced_value": 6919.29,
"providers": [{"uuid": "2ea19f8f8bcda4fa5e54e139852e0a7459d16b49",
"company_id": "A12345678",
"company_name": "EMPRESA 1 SA"
}
],
"invoices": [{"uuid": "6b556584df0721e5f0b27448247c9682a6470d11",
"invoice_id": "2023-53",
"provider_id": "A12345678",
"operation_date": "2023-10-25",
"due_date": "2024-01-24",
"amount": 918.45,
"status": "advanced",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"employment": {"summary": {"totalDaysRegistered": 8912,
"daysInMultipleActivity": 130,
"daysContributedForBenefits": 8782,
"totalTimeEquivalence": "24 años, 0 meses y 17 días."
},
"periods": [{"employer": "TRABAJADOR AUTONOMO",
"regime": "AUTONOMO",
"contract": "INDEFINIDO.TIEMPO COMPLETO.ORDINARIO",
"category": "INGENIEROS LICENCIADOS",
"actualStartDate": "2022-11-10",
"startDate": "2022-11-10",
"endDate": "Actual",
"contributedDays": 1062
}
]
},
"guarantees": [{"uuid": "90763109952d4f2ebece8dceca8254078c5384a0",
"code": "f2eb8HsfBDSDseBw8HeSccOwJweJ2OfxH2xDw8Ss",
"name": "Aval Financiero",
"nickname": "Aval Técnico",
"subtype": "financial",
"currency": "EUR",
"linked_account": "ES1001289462580857003432",
"issuer": "Bankinter, S.A.",
"beneficiary": "AYUNTAMIENTO DE MADRID",
"purpose": "Licitación obra pública expediente 2025/00123",
"issue_date": "2024-06-12",
"expiration_date": "2026-06-11",
"status": "active",
"balances": {"guaranteed_amount": 50000,
"exposure": 0,
"available": 50000,
"euro_equivalent": 50000
},
"fees_commissions": {"periodicity": "quarterly",
"last_charge_date": "2025-03-31",
"last_charge_amount": 125
},
"additional_info": [{"key": "euroEquivalent",
"value": "0.00"
}
]
}
]
},
"statistics": {"SESSION": Infinity,
"execution_time": 0.958119869232178,
"warnings": [{"code": 1000,
"message": "No contracted funds",
"product_type": "portfolios"
}
],
"operation_id": "1827C79229",
"token": "FRJ0mHlaqZwLzu"
}
}
]

Liste over transaktionstyper

query Parameters

lang	string Default: "es" Enum: "es" "en" Response language

Responses

Response samples

Content type

application/json

[[{"type": 100,
"literal": "Dividend collection"
}
]
]

Forespørg tokens tilknyttet en api_key

Brug denne metode til at forespørge alle tokens knyttet til en specifik api_key. Resultaterne returneres i blokke af 500 tokens pr. side.

Request Body schema: application/x-www-form-urlencoded
required

api_key	string api_key til at identificere klienten i tjenesten
page	number Angiv sidenummeret du vil hente. Hver side indeholder op til 500 tokens. Hvis ikke angivet, er standardværdien `1`.

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

api_key=12345678&page=1

Response samples

Content type

application/json

[{"token": "string",
"entity_code": "string",
"created_at": "2019-08-24T14:15:22Z",
"accesed_at": "2019-08-24T14:15:22Z",
"times_accesed": 0,
"latest_code": 0,
"latest_session": "string"
}
]

Tilbagekald et token

Denne metode tillader tilbagekaldelse af et eksisterende token for at deautorisere fremtidige API-adgangsanmodninger.

Request Body schema: application/x-www-form-urlencoded
required

api_key	string Identificerer klienten i tjenesten
token	string Token der skal tilbagekaldes.

Responses

Response samples

Content type

application/json

{"success": true,
"message": "Token successfully revoked."
}

Gentildel et token til en anden api_key

Denne metode tillader gentildeling af et token fra én api_key til en anden.

Request Body schema: application/x-www-form-urlencoded
required

api_key_source	string api_key hvorfra tokenet skal gentildeles.
api_key_target	string api_key som tokenet skal gentildeles til.
token	string Token der skal gentildeles.

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

api_key_source=12345678&api_key_target=87654321&token=FRJ0mHlaqZwLzu

Response samples

Content type

application/json

{"success": true,
"message": "Token successfully reassigned."
}

Tilføj et nyt domæne

Tilføjer forbindelsen mellem domænet, der skal hoste widgetten, og destinations-webhook. Af sikkerhedsmæssige årsager er redigerings- og sletteoperationer kun mulige ved at anmode om dem fra support

Request Body schema: application/x-www-form-urlencoded
required

method required	string Method to execute.
api_key required	string User's API key.
domain required	string Domain to add.
url_callback required	string URL for callback.
tokenize required	string Indicates whether to tokenize or not.

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

method=add&api_key=12345678&domain=https%3A%2F%2Fwww.cliente.com&url_callback=https%3A%2F%2Fwww.cliente.com%2Fwebhooks%2Fwealthreader&tokenize=1

Response samples

Content type

application/json

{"success": true,
"message": "string"
}

Liste over fejlkoder

Liste over fejlkoder. Vær særligt opmærksom på, at ikke alle fejlkoder skal modtage den samme behandling fra din applikation. For en forkert adgangskode-fejl skal du ikke prøve kaldet igen med de samme parametre, men for en fejl, der indikerer, at enheden er under vedligeholdelse, kan du prøve igen. Anmod om en teknisk session med vores team for at løse eventuelle spørgsmål om fejlhåndtering.

query Parameters

lang	string Default: "es" Enum: "es" "en" Response language

Responses

Response samples

Content type

application/json

[[{"code": 2,
"description": "Incorrect call",
"possible_reasons": "Some of the required parameters have not been sent or have been sent in an incorrect format",
"how_to_proceed": "The text received in \"message\" will detail the reason for the error. For example, \"The parameter \"api_key\" is mandatory\"."
}
]
]

Liste over advarselskoder

Liste over advarselskoder.

query Parameters

lang	string Default: "es" Enum: "es" "en" Response language

Responses

Response samples

Content type

application/json

[[{"code": 2,
"description": "Incorrect call",
"possible_reasons": "Some of the required parameters have not been sent or have been sent in an incorrect format",
"how_to_proceed": "The text received in \"message\" will detail the reason for the error. For example, \"The parameter \"api_key\" is mandatory\"."
}
]
]

Advanced

Valgfrie endpoints, der ikke kræves til standardintegrationer. Brug kun, hvis eksplicit instrueret af Wealth Reader.

Henter listen over understøttede enheder

Henter listen over understøttede enheder og oplysningerne, der er nødvendige for at tegne enhedens login-formular.

query Parameters

show_only_tested

integer

Default: 0

Enum: 0 1

Indicates whether to show only tested entities. Default value is 0. In production environments, always use 1.

Responses

Response samples

Content type

application/json

[{"code": "bancamarch",
"name": "Bancamarch",
"logo": "https://cdn.wealthreader.com/bancamarch.svg",
"color": "#e23e4d",
"inputs": {"document_type": {"required": false,
"name": "DNI;Pasaporte"
},
"user": {"required": true,
"name": "Username"
},
"password": {"required": true,
"name": "Access key"
}
},
"statistics": {"SESSION": Infinity,
"execution_time": 0.958119869232178,
"warnings": [{"code": 1000,
"message": "No contracted funds",
"product_type": "portfolios"
}
],
"operation_id": "1827C79229",
"token": "FRJ0mHlaqZwLzu"
}
}
]

Verificer bankkontoejerskab via IBAN

Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Tillader verifikation af om en fysisk eller juridisk person er indehaver af en specifik bankkonto ved brug af IBAN og identifikationsdata for den påståede indehaver.

Request Body schema: application/x-www-form-urlencoded
required

api_key required	string Identifies the client in the service
iban required	string IBAN code of the bank account to verify (without spaces)
document_type required	string Enum: "NIF" "NIE" "Pasaporte" "CIF" Type of identification document
document_number required	string Identification document number
holder_name required	string Full name of the natural person or company name

Responses

Request samples

Payload

Content type

application/x-www-form-urlencoded

api_key=12345678&iban=ES4914651234561234567890&document_type=NIF&document_number=12345678Z&holder_name=LUIS%20GARCIA%20BAQUERO

Response samples

Content type

application/json

{"success": true,
"result": {"code": 1,
"message": "The IBAN belongs to the indicated holder"
},
"statistics": {"SESSION": Infinity,
"execution_time": 0.958119869232178,
"warnings": [{"code": 1000,
"message": "No contracted funds",
"product_type": "portfolios"
}
],
"operation_id": "1827C79229",
"token": "FRJ0mHlaqZwLzu"
}
}

Registrer en ny bruger

Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Dette endpoint tillader registrering af en bruger enten på porteføljeoverførselsplatformen Easytransfer eller på rapporteringsværktøjet Acumulas, baseret på en unik identifikator.

Request Body schema: application/x-www-form-urlencoded
required

api_key required	string Authentication key (8 alphanumeric characters)
user_id required	string User identification document.
service required	string Enum: "integra" "easy-transfer" Service associated with the user. Determines the data flow.
email required	string <email> User email, used according to service type.

Responses

Response samples

Content type

application/json

{"success": true,
"message": "User registered successfully"
}

Tjek brugerregistreringsstatus

Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Tjekker om en bruger er registreret i Easytransfer- eller Acumulas-systemet og returnerer det unikke adgangslink for brugeren.

Request Body schema: application/x-www-form-urlencoded
required

api_key required	string Authentication key
user_id required	string User identification document.

Responses

Response samples

Content type

application/json

{"success": true,
"registered": true,
"user_id": "12345",
"links": {"easy-transfer": "https://singularbank.wealthreader.com/...",
"integra": "https://www.acumulas.com/register?..."
}
}

Tilbagekald en tidligere registreret bruger

Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Dette endpoint tillader afregistrering af en bruger fra Easytransfer- eller Acumulas-platformtjenesten.

Request Body schema: application/x-www-form-urlencoded
required

api_key required	string Authentication key (8 alphanumeric characters)
user_id required	string User identification document.
service required	string Enum: "integra" "easy-transfer" "all" Service from which to unregister the user. 'all' for all services.

Responses

Response samples

Content type

application/json

{"success": true,
"message": "User unregistered successfully"
}

Batch-forbindelsesindlæsning

Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Vigtigt: For at bruge batchproceshåndtering på Wealthreader-siden kræves et dedikeret miljø. Dette endpoint er ikke tilgængeligt på api.wealthreader.com. Endpoints grupperet under "batch"-tagget tillader asynkron behandling af flere bankforbindelser, i modsætning til den synkrone /entities/ metode. Ideel til behandling af store mængder forbindelser og undgåelse af timeouts.

Request Body schema: application/json
required

api_key required	string Identifies the client in the service
notification_url required	string <uri> URL where notification will be sent when batch processing finishes
required	Array of objects (batch-connection) non-empty List of connections to process

Responses

Request samples

Payload

Content type

application/json

{"api_key": "12345678",
"notification_url": "https://example.com/webhook/batch-complete",
"connections": [{"code": "caixabank",
"token": "token123",
"product_types": "accounts,portfolios"
},
{"code": "BBVA",
"token": "token456",
"product_types": "accounts",
"date_from": "2024-01-01"
}
]
}

Response samples

Content type

application/json

{"success": true,
"batch_id": "batch_20250120_a1b2c3d4",
"total_connections": 5,
"estimated_completion_time": "2025-01-20T10:45:00Z"
}

Hent generelle statistikker om batch-forbindelser

Dette endpoint er valgfrit. Henter generelle statistikker om behandlingsresultatet for alle forbindelser i en batch.

Request Body schema: application/json
required

api_key required	string Identifies the client in the service
batch_id required	string Batch ID

Responses

Request samples

Payload

Content type

application/json

{"api_key": "string",
"batch_id": "string"
}

Response samples

Content type

application/json

{"success": true,
"batch_id": "batch_20250120_a1b2c3d4",
"status": "completed",
"statistics": {"start_time": "2019-08-24T14:15:22Z",
"end_time": "2019-08-24T14:15:22Z",
"total_execution_time": 125.5,
"total_connections": 8,
"successful_connections": 7,
"failed_connections": 1
}
}

Hent individuelt resultat af en specifik forbindelse inden for en batch

Dette endpoint er valgfrit. Henter resultatet af en specifik forbindelse fra batchen.

Request Body schema: application/json
required

api_key required	string Identifies the client in the service
batch_id required	string Batch ID
credential_id required	string Filter by specific credential_id

Responses

Request samples

Payload

Content type

application/json

{"api_key": "string",
"batch_id": "string",
"credential_id": "string"
}

Response samples

Content type

application/json

{"success": true,
"payload": {"user_information": {"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"gender": "male",
"birth_date": "1980-09-26",
"birth_place": "Ibiza",
"email": "[email protected]",
"cell_phone": "+34666123456",
"address": "CALLE BAILEN 41 1A",
"city": "MADRID",
"country": "SPAIN",
"postal_code": "28005",
"marital_status": "married",
"job": "CUENTA PROPIA"
},
"portfolios": [{"subtype": "funds",
"uuid": "05e4563f5bbf2d06efd0a29ebe7edbbb4e1bff63",
"code": "1465010091400123456789",
"name": "Fondo Dinámico",
"currency": "EUR",
"total_value": 3275.6,
"weighted_return": 8.49,
"annualized_volatility": 0,
"yield": 256.27,
"contributions": 3019.33,
"withholdings": 0,
"contracting_date": "2016-04-27",
"linked_account": "ES4021005321592566566159",
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"composition": {"currency": "EUR",
"weighting": 100,
"shares": 225.0077,
"price": 14.5577,
"total_amount": 3275.6
},
"transactions": [{"uuid": "05e4563f5bbf2d06efd0a29ebe7edbbb4e1bff63",
"operation_pending": false,
"operation_date": "2020-01-30",
"value_date": "2020-01-30",
"operation_type": "purchase",
"shares": 1076.8273,
"price": 11.1438,
"total_amount": 12000,
"reference_currency": "EUR",
"currency": "EUR",
"exchange_rate": 1
}
]
}
],
"bonds": [{"uuid": "b8e42d60e6e8d3a5efb0b2a8e4e0b1a4b5c5d6e7",
"name": "Bono del Estado Español 2025",
"isin": "ES00000123E5",
"currency": "EUR",
"total_value": 5000,
"interest_rate": 1.75,
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"maturity_date": "2025-10-15",
"issuer": "Gobierno de España",
"principal": 1000,
"coupon_payment_dates": ["2023-04-15",
"2023-10-15"
],
"credit_rating": "AAA",
"yield_to_maturity": 2.5,
"current_yield": 2,
"callability": "Callable a partir del 2024-01-01",
"type_of_bond": "government"
}
],
"accounts": [{"uuid": "8076932f04f73e27fe608fee4d12fca8708dec8c",
"subtype": "checking",
"interest_rate": 0.5,
"line_of_credit_details": {"credit_limit": 50000,
"interest_rate": 4.5,
"credit_used": 15000,
"credit_available": 35000,
"constitution_date": "2021-05-20",
"expiration_date": "2031-05-20"
},
"code": "ES4914651234561234567890",
"name": "Cuenta NÓMINA",
"currency": "EUR",
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"balances": {"available": 14302.07,
"current": 14302.07
},
"additional_info": [{"key": "string",
"value": "string"
}
],
"transactions": [{"uuid": "d0c2ea4c072cf4d7b0fd494d7728260d736e6b25",
"operation_date": "2022-12-30",
"value_date": "2022-12-30",
"amount": -1.1,
"balance": 14302.07,
"description": "Pago en TELPARK MADRID ES",
"pdf_file": "string",
"pdf_file_final": true,
"categorization": {"type": 1,
"portfolio-uuid": "1465010091400123456789",
"ISIN": "US88160R1014"
},
"transfer_details": {"concept": "Pago de factura 12345",
"sender_receiver": "Juan Pérez",
"account_number": "ESXX12341234121234567890"
},
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"cards": [{"status": "active",
"subtype": "credit",
"uuid": "aefd89eade0a6a09d9b8eab4c22da6a6a37632e6",
"code": "516097********1234",
"name": "Credit Card",
"currency": "EUR",
"next_payment_date": "2023-01-05",
"anual_interest": 17.48,
"tae": 18.95,
"balances": {"available": 3980,
"limit": 4000,
"disposed": 20
},
"linked_account": "ES4021005321592566566159",
"owner": {"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
},
"additional_info": [{"key": "string",
"value": "string"
}
],
"transactions": [{"uuid": "78ceedca9cd9d2f2bfbb2439795ab6a1fcefc12b",
"settled": false,
"operation_date": "2022-12-28",
"value_date": "2022-12-28",
"amount": -20,
"currency": "EUR",
"exchange_rate": 1,
"description": "Pago en AMZN MKTP ES123CM0ZM4",
"categorization": {"type": 0
},
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"receipts": [{"last_receipt_date": "2023-07-23",
"issuer": "Canal de Isabel II",
"description": "RECIBO CONTRATO 328774628 FACTURA DEL 18 07 23",
"account": "ES0123456789012345678901",
"status": "paid",
"amount": 50.75,
"pdf_file": "string",
"pdf_file_settled": true
}
],
"loans": [{"contract_number": "9620.321-205439-70",
"loan_type": "Variable rate mortgage",
"constitution_date": "2022-02-23",
"currency": "EUR",
"granted_capital": 207000,
"pending_amount": 166639.77,
"next_installment": 1040.3,
"linked_account": "ES0123456789012345678901",
"holders": [{"id": "32945945D",
"name": "Diego Serrano"
}
],
"interest_rate": 3.768,
"expiration_date": "2042-03-01",
"pending_receipts": 223,
"amortization_made": [{"date": "2022-12-01",
"amortized": 515.43,
"interest": 524.87,
"total": 1040.3,
"pending_capital": 166639.77,
"operation_type": "receipt_paid"
}
],
"amortization_pending": [{"date": "2030-12-01",
"amortized": 515.43,
"interest": 524.87,
"total": 1040.3,
"pending_capital": 66639.77,
"operation_type": "receipt_scheduled"
}
]
}
],
"deposits": [{"uuid": "0ae4d722b1c82feeafb4b36b2893230444071335",
"code": "DPZ-1234567890",
"name": "12-month deposit",
"currency": "EUR",
"principal": 10000,
"pending_principal": 5000,
"start_date": "2024-09-01",
"maturity_date": "2025-09-01",
"payment_frequency": "at_maturity",
"capitalization": "none",
"rate_type": "fixed",
"nominal_interest_rate": 3,
"apr_tae": 3.04,
"day_count_convention": "ACT/365",
"linked_account": "ES4021005321592566566159",
"accrued_interest": 24.58,
"expected_interest_total": 300,
"withholding_tax_rate": 19,
"status": "active",
"auto_renewal": {"enabled": false,
"renewed_times": 0,
"next_renewal_date": "2019-08-24",
"renewal_term_months": 0
},
"early_withdrawal": {"allowed": true,
"penalty_type": "interest_loss",
"penalty_value": 100,
"notes": "Loss of accrued interest for the current period"
},
"owners": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"interest_movements": [{"uuid": "90763109952d4f2ebece8dceca8254078c5384a0",
"scheduled": false,
"date": "2025-09-01",
"period_start": "2024-09-01",
"period_end": "2025-09-01",
"currency": "EUR",
"gross_interest": 300,
"withholding_tax": 57,
"net_interest": 243,
"payment_type": "maturity"
}
],
"principal_movements": [{"date": "2019-08-24",
"type": "opening",
"amount": 12000,
"currency": "string",
"target_account": "string"
}
]
}
],
"leases": [{"subtype": "leasing",
"uuid": "1f0a0b1c2d3e4f5a6b7c8d9e0f1234567890abcd",
"contract_number": "L-2024-000123",
"name": "BMW 3 Series Leasing",
"provider": {"name": "Banco XYZ Renting, S.A.",
"tax_id": "A12345678"
},
"currency": "EUR",
"start_date": "2024-10-01",
"end_date": "2028-09-30",
"term_months": 48,
"payment_frequency": "monthly",
"status": "active",
"linked_account": "ES4021005321592566566159",
"holders": [{"ID": "12345678Z",
"name": "LUIS GARCIA BAQUERO",
"role": "owner"
}
],
"asset": {"category": "vehicle",
"description": "BMW 320d Touring",
"vin": "WBA8G51040K123456",
"license_plate": "1234-ABC",
"brand": "BMW",
"model": "320d",
"year": 2024,
"serial_number": "string",
"address": "string"
},
"financials": {"capital_financed": 35000,
"nominal_interest_rate": 4.25,
"apr_tae": 4.38,
"discount_rate": 0,
"initial_fee": 3000,
"security_deposit": 1000,
"residual_value": 12000,
"purchase_option": true,
"services_included": {"maintenance": true,
"insurance": true,
"roadside_assistance": true,
"tires": false
},
"vat_included": true,
"mileage_limit_year": 15000,
"early_termination": {"allowed": true,
"penalty_type": "percentage_of_remaining",
"penalty_value": 40
}
},
"totals": {"paid_installments": 10,
"remaining_installments": 38,
"total_paid": 0,
"total_pending": 0,
"principal_outstanding": 0,
"accrued_interest": 0
},
"installments": {"paid": [{"uuid": "b07a1a0d3e6f4c2a9e1d0f8b7c6a5e4d3c2b1a0f",
"date": "2025-01-01",
"status": "pending",
"currency": "EUR",
"total": 625.5,
"breakdown": {"principal": 450,
"interest": 80,
"services": 70,
"taxes": 25.5,
"fees": 0
},
"value_date": "2019-08-24",
"receipt_uuid": "string",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
],
"scheduled": [{"uuid": "b07a1a0d3e6f4c2a9e1d0f8b7c6a5e4d3c2b1a0f",
"date": "2025-01-01",
"status": "pending",
"currency": "EUR",
"total": 625.5,
"breakdown": {"principal": 450,
"interest": 80,
"services": 70,
"taxes": 25.5,
"fees": 0
},
"value_date": "2019-08-24",
"receipt_uuid": "string",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
}
],
"properties": [{"uuid": "string",
"code": "string",
"description": "string",
"purpose": "string",
"currency": "string",
"trading_price": 0,
"trading_year": 0,
"historic_prices": [{"date": "2019-08-24",
"price": 0
}
]
}
],
"files": [{"file_date": "2023-07-21",
"retrieval_type": "repository",
"file_type": "Norma 43",
"description": "Monthly account statement",
"content": "string"
}
],
"contracts": [{"signing_date": "2003-09-26",
"type": "loan",
"subtype": "mortgage",
"description": "Variable rate mortgage",
"pdf_file": "string"
}
],
"factoring": [{"uuid": "a62ae601a424403d0fbe968d335378421006c277",
"contract_number": "000117001234567",
"name": "FACTORING PPAL SIN RECURSO",
"currency": "EUR",
"balances": {"available": 11360.26,
"disposed": 0,
"limit": 11360.26
},
"interest_rate": 5.25,
"linked_account": "ES0700812345678987654321",
"next_payment_date": "",
"number_invoices": 8,
"total_value": 14495.28,
"total_advanced_value": 6919.29,
"providers": [{"uuid": "2ea19f8f8bcda4fa5e54e139852e0a7459d16b49",
"company_id": "A12345678",
"company_name": "EMPRESA 1 SA"
}
],
"invoices": [{"uuid": "6b556584df0721e5f0b27448247c9682a6470d11",
"invoice_id": "2023-53",
"provider_id": "A12345678",
"operation_date": "2023-10-25",
"due_date": "2024-01-24",
"amount": 918.45,
"status": "advanced",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"confirming": [{"uuid": "a62ae601a424403d0fbe968d335378421006c277",
"contract_number": "000117001234567",
"name": "CONFIRMING PPAL SIN RECURSO",
"currency": "EUR",
"balances": {"available": 11360.26,
"disposed": 0,
"limit": 11360.26
},
"interest_rate": 5.25,
"linked_account": "ES0700812345678987654321",
"next_payment_date": "",
"number_invoices": 8,
"total_value": 14495.28,
"total_advanced_value": 6919.29,
"providers": [{"uuid": "2ea19f8f8bcda4fa5e54e139852e0a7459d16b49",
"company_id": "A12345678",
"company_name": "EMPRESA 1 SA"
}
],
"invoices": [{"uuid": "6b556584df0721e5f0b27448247c9682a6470d11",
"invoice_id": "2023-53",
"provider_id": "A12345678",
"operation_date": "2023-10-25",
"due_date": "2024-01-24",
"amount": 918.45,
"status": "advanced",
"additional_info": [{"key": "string",
"value": "string"
}
]
}
]
}
],
"employment": {"summary": {"totalDaysRegistered": 8912,
"daysInMultipleActivity": 130,
"daysContributedForBenefits": 8782,
"totalTimeEquivalence": "24 años, 0 meses y 17 días."
},
"periods": [{"employer": "TRABAJADOR AUTONOMO",
"regime": "AUTONOMO",
"contract": "INDEFINIDO.TIEMPO COMPLETO.ORDINARIO",
"category": "INGENIEROS LICENCIADOS",
"actualStartDate": "2022-11-10",
"startDate": "2022-11-10",
"endDate": "Actual",
"contributedDays": 1062
}
]
},
"guarantees": [{"uuid": "90763109952d4f2ebece8dceca8254078c5384a0",
"code": "f2eb8HsfBDSDseBw8HeSccOwJweJ2OfxH2xDw8Ss",
"name": "Aval Financiero",
"nickname": "Aval Técnico",
"subtype": "financial",
"currency": "EUR",
"linked_account": "ES1001289462580857003432",
"issuer": "Bankinter, S.A.",
"beneficiary": "AYUNTAMIENTO DE MADRID",
"purpose": "Licitación obra pública expediente 2025/00123",
"issue_date": "2024-06-12",
"expiration_date": "2026-06-11",
"status": "active",
"balances": {"guaranteed_amount": 50000,
"exposure": 0,
"available": 50000,
"euro_equivalent": 50000
},
"fees_commissions": {"periodicity": "quarterly",
"last_charge_date": "2025-03-31",
"last_charge_amount": 125
},
"additional_info": [{"key": "euroEquivalent",
"value": "0.00"
}
]
}
]
},
"statistics": {"SESSION": Infinity,
"execution_time": 0.958119869232178,
"warnings": [{"code": 1000,
"message": "No contracted funds",
"product_type": "portfolios"
}
],
"operation_id": "1827C79229",
"token": "FRJ0mHlaqZwLzu"
}
}

Wealth Reader (8.1.3)

Core

Henter finansielle aktiver og detaljer om deres sammensætning

Request Body schema: application/x-www-form-urlencoded

Responses

Request samples

Response samples

Liste over transaktionstyper

query Parameters

Responses

Response samples

Forespørg tokens tilknyttet en api_key

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Request samples

Response samples

Tilbagekald et token

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Gentildel et token til en anden api_key

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Request samples

Response samples

Tilføj et nyt domæne

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Request samples

Response samples

Liste over fejlkoder

query Parameters

Responses

Response samples

Liste over advarselskoder

query Parameters

Responses

Response samples

Advanced

Henter listen over understøttede enheder

query Parameters

Responses

Response samples

Verificer bankkontoejerskab via IBAN

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Request samples

Response samples

Registrer en ny bruger

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Tjek brugerregistreringsstatus

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Tilbagekald en tidligere registreret bruger

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Batch-forbindelsesindlæsning

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Hent generelle statistikker om batch-forbindelser

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Hent individuelt resultat af en specifik forbindelse inden for en batch

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required