Flanks Data Model
In our product you can find many fields that have been standardized by Flanks. In this section you can find different types for products and transactions.
This page is subject to change and new types may be added in the future.
Portfolios
Field |
Description |
---|---|
name |
portfolio name set by the "entity". |
type |
type of portfolio depends on the investments it contains, if it contains several types it will be marked as MIX otherwise it will follow the Portfolio Types table. |
currency |
Currency of the product. Follow the ISO 4217. |
_id |
Unique ID of the product, based on the user credentials_token and the refValores number. |
refValores * |
Number of the investments accounts from the entity. In some case the portfolio can be cancelled and the data not accessible. |
refAccount * |
IBAN of main cash account related to the portfolio. |
refAccounts * |
IBAN of all cash account related to the portfolio. |
owners |
List of the holders of the portfolio. |
balance |
Current valuation of the portfolio on the currency. |
entity |
Name of the entity where the credentials belongs to. |
external_id * |
Same as the _id field, but it is based on the external_id associated on the user credentials_token instead of the credentials_token. In case there is no external_id for the user, the value of this field is null. |
updated_at_timestamp |
Last time when the portfolio was seen and the information was refreshed. |
* Can be null
Portfolio Types
The type of the portfolio depends on the investment it contains.
API Value |
Investment type inside portfolio |
---|---|
M (Managed) |
Any type |
UM (Unmanaged) |
Any type |
F |
F |
S |
VI |
CFD |
CFD |
PP |
PP |
FI |
FI |
C |
C |
ETF |
ETF |
L |
L |
O |
O |
DV |
DV |
BP |
BP |
AEP |
AEP |
MIX |
More than one type of investment mentioned above |
Investments
Field |
Description |
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
_id |
Unique ID of the product, based on the user credentials_token and the ISIN number. |
||||||||||||||||||||
name |
General name of the product. |
||||||||||||||||||||
isin |
General identification number, if the product has other identifiers they will be included in this field. |
||||||||||||||||||||
cusip * |
Nine-digit alphanumeric code that identifies a North American financial security. |
||||||||||||||||||||
symbol * |
Market symbol of the product in case that the product is equity. |
||||||||||||||||||||
entity |
Name of the entity where the credentials belongs to. |
||||||||||||||||||||
amount |
Number of shares the user has on this product. |
||||||||||||||||||||
balance |
Valuation of the investment using the currency of the product. |
||||||||||||||||||||
currency |
Currency of the product. Follows the ISO 4217. |
||||||||||||||||||||
portfolio_id |
Flanks identifier that can be linked with the _id of the /portfolios call. |
||||||||||||||||||||
detail |
This field will return some public information of the product. We can link your product with information sources like MorningStar or Bloomberg. |
||||||||||||||||||||
external_id * |
Same as the _id field, but it is based on the external_id associated on the user credentials_token instead of the credentials_token. In case there is no external_id for the user, the value of this field is null. |
||||||||||||||||||||
cost * |
Investment cost at time of purchase. |
||||||||||||||||||||
is_nominal |
Indicates if amount is in participations or in nominal. |
||||||||||||||||||||
cnmv * |
This field will be included only if the product is a Fund (investment type F) and is registered with the CNMV.
|
||||||||||||||||||||
dgs * |
This field will be included if the product is a Pension Plan
|
||||||||||||||||||||
initial_date * |
Date of first buy, subscription or switch was realized. |
||||||||||||||||||||
valuation_date * |
Date where balance was calculated, if given by the bank. |
||||||||||||||||||||
expiration_date * |
For fixed-income investments (type FI) is the maturity date. |
||||||||||||||||||||
performance * |
Those issues dealing with the amount and value of money, wealth, debt, and investment. The performance is a decimal number expressed as per unit. An example would be a performance of 0.2, which in percentage would be 20%. |
||||||||||||||||||||
performance_detail * |
The performance detail are taken over 1, not percentage.
|
||||||||||||||||||||
analytics * |
The ratios are taken over 1, not percentage.
|
||||||||||||||||||||
interest * |
Interest rating information for the investment
|
||||||||||||||||||||
market * |
ISO MIC code (ISO 10383). |
||||||||||||||||||||
operating_market * |
ISO Operating MIC code (ISO 10383). |
||||||||||||||||||||
capital_gain * |
A capital gain is an increase in the value of an asset or investment resulting from the price appreciation of the asset or investment. |
||||||||||||||||||||
accrued_interest * |
Accrued interest refers to the amount of interest that has been incurred, as of a specific date, on a loan or other financial obligation but has not yet been paid out. Accrued interest can either be in the form of accrued interest revenue, for the lender, or accrued interest expense, for the borrower. Is a number over 1 not percentage. |
||||||||||||||||||||
price_ex_cupon * |
The present discounted value of future cash stream generated by a bond. It refers to the sum of the present values of all likely coupon payments plus the present value of the par value at maturity. |
||||||||||||||||||||
type |
Investment type. See types available in the Investment Types table. |
||||||||||||||||||||
subtype * |
Investment subtype. See subtypes available in the Investment Subtypes table. |
||||||||||||||||||||
leverage * |
Leverage of the investment. |
||||||||||||||||||||
placing_bank * |
For deposits is the bank where the money is placed. |
||||||||||||||||||||
updated_at_timestamp |
Last time when the investment was seen and the information was refreshed. |
||||||||||||||||||||
country_model |
List of objects with product data whose content varies depending on the given country. If not available, the list will be empty. This field aggregates data for the countries listed in the Country Model table. |
* Can be null
Investment Country Model
Country |
Fields |
||||
---|---|---|---|---|---|
Brazil |
|
||||
Mexico |
|
Investment Types
Type |
Description |
---|---|
F |
Funds |
VI |
Variable Income |
PP |
Pension Plan |
FI |
Fixed Income |
C |
Crypto Currencies |
ETF |
Exchange-Traded Fund |
CFD |
Contract For Differences |
L |
Liquidity |
O |
Others |
DV |
Derivatives |
BP |
Bank Products |
AEP |
Alternative and Emerging Products |
Investment Subtypes
Flanks Investment Subtype |
API Representation |
Investment type |
---|---|---|
Forex Option |
FOP |
Derivatives |
Option |
OP |
Derivatives |
Futures |
FT |
Derivatives |
Warrants |
W |
Derivatives |
Commodities |
COM |
Derivatives |
Forex forwards |
FF |
Derivatives |
Certificate Deposit |
CD |
Bank Products |
Private Equity |
PE |
Alternative and Emerging Products |
Real Asset |
RA |
Alternative and Emerging Products |
Investment Transactions
Field |
Description |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
accountDest * |
For funds transfer (type 4 and symb "-") is the refvalores of the portfolio receiving the transfer. |
||||||||||
accrued_interest * |
Total quantity of accrued interest in buy and sells of fixed-income asset in. |
||||||||||
amount |
Number of shares involved on the investment_transaction, it will be negative or positive depending on the investment type. |
||||||||||
amountDest * |
for funds transfer (type 4 and symb "-") is the number of titles in the counterpart transaction. |
||||||||||
balance * |
Number of accumulated shares after the transaction. |
||||||||||
commission * |
Commission of the transaction. |
||||||||||
commissionDest * |
For funds transfer (type 4 and symb "-") is the commission in the counterpart transaction. |
||||||||||
commission_detail |
Commission breakdown, composed by:
|
||||||||||
currency |
Currency, same as investment currency. Follows the ISO 4217. All quantities of the transaction are given in this currency. |
||||||||||
currencyDest * |
For funds transfer (type 4 and symb "-") is the currency in the counterpart transaction. |
||||||||||
description |
Concept of the investment_transaction, it will appear standardized on the type field. |
||||||||||
entity |
Entity name of the associated credentials. |
||||||||||
exchange |
Multiplier to convert between investment currency and portfolio currency. 1 unit of investment currency is equivalent to "exchange" units of portfolio currency. It's 1.0 if both currencies are equal. |
||||||||||
exchangeToPaymentCurrency |
Multiplier to convert between investment currency and payment currency. 1 unit of investment currency is equivalent to "exchangeToTransactionCurrency" units of transaction currency. It's 1.0 if both currencies are equal. |
||||||||||
exchangeToTransactionCurrency |
Multiplier to convert between investment currency and transaction currency. 1 unit of investment currency is equivalent to "exchangeToTransactionCurrency" units of transaction currency. It's 1.0 if both currencies are equal. |
||||||||||
expenses * |
Expense is the cost associated to the operation. |
||||||||||
expenses_detail |
Expense is the cost of operations that a company incurs to generate revenue. The expenses details are:
|
||||||||||
external_id * |
Same as the _id field, but it is based on the external_id associated on the user credentials_token instead of the credentials_token. In case there is no external_id for the user, the value of this field is null. |
||||||||||
investment_id |
Flanks id of the investment, it can be linked with the /investment response. |
||||||||||
isin |
ISIN or DGS of the product related to the transaction. |
||||||||||
isinDest * |
For funds transfer (type 4 and symb "-") is the isin number in the counterpart transaction. |
||||||||||
leverage * |
If applies is the leverage of the transaction. |
||||||||||
netCash |
Net cost of the transaction. |
||||||||||
netCashDest * |
For funds transfer (type 4 and symb "-") is the cash quantity in the counterpart transaction. |
||||||||||
operationDate |
Date when the investment_transaction was ordered. |
||||||||||
order_id * |
Id identifier of the order belonging the transaction, given by the bank. |
||||||||||
origin_gain |
|||||||||||
origin_gain_detail * |
Is a list of dictionaries. The keys of the dictionaries are the same as in origin gain. Origin gain detail is the historical data of each transfer. |
||||||||||
originalCurrency |
Original investment currency value. |
||||||||||
pair_transaction_id * |
For forex transactions. Relates pair transactions. |
||||||||||
paymentCurrency |
The currency of the account where the transaction was settled. |
||||||||||
refAccountIBAN * |
IBAN of the associated current account of the portfolio that contains the investment related to the transaction. |
||||||||||
referenceCurrency |
Currency reference of the portfolio that contains the investment related to the transaction. |
||||||||||
refValos * |
Contract of the portfolio containing the investment related to the transaction. |
||||||||||
retention * |
Total retention of the transaction. |
||||||||||
retention_detail * |
Retention breakdown, composed by origin and destination retention. Values inside can be null. |
||||||||||
reversal_type * |
Type of the transaction reverted, only if type is "28". |
||||||||||
symb |
Indicates if the transaction increases (+) or decreases (-) the number of participations or titles. |
||||||||||
symbDest * |
For funds transfer (type 4 and symb "-") is the symb field ('+') in the counterpart transaction. |
||||||||||
transaction_id * |
Id identifier for the transactions given by the bank. |
||||||||||
transactionCurrency |
Currency in which transaction values were reported. Follows the ISO 4217. |
||||||||||
unitPrice |
Price of the participations or titles at the moment of the transaction. |
||||||||||
type |
Standard type of the investment_transaction, you will find all the operations that we have in the Investment Transaction Types table. |
||||||||||
unitPriceDest * |
for funds transfer (type 4 and symb "-") is the price of titles in the counterpart transaction |
||||||||||
valueDate |
Date when the investment_transaction was effective. |
||||||||||
valueDateDest * |
for funds transfer (type 4 and symb "-") is valueDate in the counterpart transaction |
||||||||||
_id |
Unique identification of the operation. |
||||||||||
country_model |
List of objects with product data whose content varies depending on the given country. If not available, the list will be empty. This field aggregates data for the countries listed in the table below: |
* Can be null
Investment Transaction Types
Flanks Investment Transaction Types |
Description |
---|---|
1 |
Subscription |
2 |
Reimbursement |
3 |
New security contract |
4 |
Funds transfer |
5 |
Reject security contract |
6 |
Pledges / Block or unblock positions |
7 |
Coupons |
8 |
Buy |
9 |
Sell |
10 |
Chargebacks |
11 |
Sum |
14 |
Commission |
17 |
Forex spot |
18 |
External funds transfer |
23 |
PP - External funds transfer |
25 |
Taxes |
26 |
Redemption |
28 |
Cancellation |
30 |
Financial operations |
32 |
Miscellaneous |
33 |
Dividends |
34 |
Interests |
35 |
ETF - Buy |
36 |
ETF - Sell |
39 |
Hedge fund - Buy |
40 |
Hedge fund - Sell |
41 |
Swap |
42 |
Contrasplit |
43 |
Capitall call |
44 |
Distribution |
47 |
Merge |
48 |
Liquidation |
49 |
Variation Margin |
50 |
Rights - purchase |
51 |
Rights - sale |
52 |
Rights - distribution |
53 |
Rights - exercise |
54 |
Rights - inclusion |
55 |
Rights - extinct |
56 |
Forex Forward |
57 |
Deposit Closing |
58 |
Deposit Decrease |
59 |
Deposit Increase |
60 |
Deposit Interest |
61 |
Deposit Opening |
62 |
Deposit Rate Change |
63 |
Buy open |
64 |
Buy close |
65 |
Sell open |
66 |
Sell close |
81 |
Crypto - send |
82 |
Crypto - request |
83 |
Crypto - transfer |
84 |
Crypto - buy |
85 |
Crypto - sell |
86 |
Crypto - receive |
90 |
Crypto - other |
Accounts
Field |
Description |
---|---|
iban |
IBAN code of the account. |
entity |
Entity identifier. |
alias |
Account alias if present, otherwise it will be same as the IBAN. |
balance |
Balance of the account. |
currency |
ISO currency code of the account. |
description * |
Description. |
isOwner * |
Indicates if credentials owner is owner of account. |
numOwners |
Number of owner with role |
owners |
Holders list. |
_id |
Unique identifier for the account, created by Flank's System. |
external_id * |
Same as the _id field, but it is based on the external_id associated on the user credentials_token instead of the credentials_token. In case there is no external_id for the user, the value of this field is null. |
type |
Account type, see more in the Account Types table. |
updated_at_timestamp |
Last time when the account was seen and the information was refreshed. |
* Can be null
Account types
API value |
Description |
---|---|
cashAccount |
Also known as checking account or current account. |
safekeepingAccount |
An account that generally earns higher interest than an interest-bearing checking account. |
nostroAccount |
A nostro account refers to an account that a bank holds in a foreign currency in another bank. |
vostroAccount |
A vostro account is an account a correspondent bank holds on behalf of another bank. |
other |
Not matching any of the previous ones |
Account transactions
Field |
Description |
---|---|
_id |
Unique ID of the cash transaction. |
account_id |
Unique ID of the cash account. Usually the IBAN. |
entity |
Name of the entity where the credentials belongs to. |
balance * |
Cash balance after the transaction. |
amount |
Total cash amount of the transaction. |
entity |
Bank where credentials_token belongs to. |
cardNumber * |
Card number in the case that are a transactions done by card. |
category * |
Category of the movement set by the bank. |
flanks_category |
Flanks category classification as indicated in the Account Transaction Flanks Category table. |
type |
Flanks transaction classification as indicated in the Account Transactions Type table. |
currency |
Currency of the transaction. |
operationDate |
Operation when the transaction was ordered. |
valueDate |
Date when the operation was received. |
description |
Concept of the transaction. |
transaction_id * |
Id identifier for the transactions given by the bank. |
transfer.beneficiary * |
Name of the beneficiary in case there are a cash transfer. |
transfer.ibanBeneficiary * |
IBAN of the beneficiary cash account. |
transfer.ibanOrdenant * |
IBAN of the payer. |
transfer.ordenant * |
Name of the payer. |
_external_id * |
Same as the _id field, but it is based on the external_id associated on the user credentials_token instead of the credentials_token. In case there is no external_id for the user, the value of this field is null. |
norma43 * |
Norma 43 code as indicated in the Account Transactions Norma 43 Codes table. |
order_id * |
Id identifier of the order belonging the transaction, given by the bank. |
pair_transaction_id * |
For forex transactions. Relates pair transactions, will contain _id of the related account transaction. |
* Can be null
Account Transactions Type
Type |
Description |
---|---|
100 |
Other |
101 |
Cancellation |
102 |
Contribution to current account |
103 |
Receipt on account of sale of financial assets |
104 |
Receipt on account of redemption of bonds |
105 |
Income on account of structured maturity |
106 |
Income on account due to maturity of guarantees |
107 |
Debit to account for collateralisation |
108 |
Charge for commissions on financial assets |
109 |
Withdrawal from current account |
110 |
Current account deposit |
111 |
Debit to account for purchase of financial assets |
112 |
Receipt |
113 |
Payment of commissions |
114 |
Deposit of dividends, coupons and other |
115 |
Deferred income from settlement of differences |
116 |
Debit to account for settlement of differences |
117 |
Taxes |
118 |
Garnishments |
119 |
Forex |
120 |
Transfers |
121 |
Rollovers |
122 |
Retention |
123 |
Bonus |
124 |
Settlement |
125 |
Account Opening |
126 |
Debit |
127 |
Credit memo |
128 |
Internal Cash Transfer |
129 |
Deposit Closing |
130 |
Deposit Increase |
131 |
Deposit Interest |
132 |
Deposit Opening |
133 |
Deposit Rate Change |
134 |
Deposit Decrease |
135 |
Forex Spot |
136 |
Forex Forward |
137 |
Account Closure |
Account Transactions Flanks Category
Type |
Description |
---|---|
200 |
OTHER |
201 |
INTEREST, COMMISSIONS, EXPENSES, TAXES |
202 |
INVESTMENT |
203 |
ATM |
204 |
DRAFTS, TRANSFERS, CHEQUES |
205 |
DIRECT DEBITS, BILLS, DRAFTS |
206 |
INSURANCE, ORGANISATIONS AND NGOS |
207 |
RESTAURANTS |
208 |
CARD |
209 |
SHOPS |
210 |
PAYROLL, PENSION |
211 |
LEISURE |
212 |
INCOME, DEPOSITS |
213 |
CANCELLATIONS, CORRECTIONS |
214 |
TRANSPORT |
215 |
LOANS, CREDITS |
216 |
HOUSE |
217 |
EDUCATION, HEALTH, BEAUTY, WELLNESS |
218 |
STUBS, WITHDRAWALS |
219 |
FOREIGN |
220 |
CREDIT MEMOS, RECEIPTS |
221 |
REFUNDS, NON-PAYMENTS, GARNISHMENTS |
Account Transactions Norma 43 Codes
Norma43 is a spanish standard for cash transaction categorization.
Code |
Description |
---|---|
01 |
VOUCHERS - WITHDRAWALS |
02 |
CREDIT NOTES - DELIVERIES - RECEIPTS |
03 |
DIRECT DEBITS - RECEIPTS - DRAFTS - PAYMENTS FROM YOUR ACCOUNT |
04 |
DRAFTS - TRANSFERS - TRANSFERS - CHEQUES |
05 |
REPAYMENT OF LOANS, CREDITS, ETC. |
06 |
REMITTANCES - BILLS OF EXCHANGE |
07 |
SUBSCRIPTIONS - DIV. LIABILITIES - SWAPS. |
08 |
COUPON DIV. - JOINT PREMIUM - REDEMPTIONS |
09 |
STOCK EXCHANGE TRANSACTIONS AND/OR PURCHASE/SALE OF SECURITIES |
10 |
PETROL CHEQUES |
11 |
AUTOMATIC TELLER MACHINE |
12 |
CREDIT CARDS - DEBIT CARDS |
13 |
FOREIGN TRANSACTIONS |
14 |
RETURNS AND DEFAULTS |
15 |
PAYROLL - SOCIAL SECURITY |
16 |
STAMPS - BROKERAGE - POLICY |
17 |
INTEREST - COMMISSIONS - CUSTODY - EXPENSES AND TAXES |
98 |
CANCELLATIONS - CORRECTIONS ENTRY |
99 |
MISCELLANEOUS |
Liabilities
Field |
Description |
||||||||
---|---|---|---|---|---|---|---|---|---|
name |
Liability name. |
||||||||
type |
Flanks Liability Type as indicated in the Liability Types table. |
||||||||
balance |
Amount to return. |
||||||||
contractNumber * |
Contract identifier obtained from the financial institution website. |
||||||||
currency |
ISO currency of the liability. |
||||||||
availableBalance * |
In case of credit amount not consumed. |
||||||||
openingDate * |
Date of opening liability contract. |
||||||||
expirationDate * |
Finish date for the liability contract. |
||||||||
_id |
Unique identifier for the liability. |
||||||||
initialCapital * |
Initial amount. |
||||||||
initialCapitalCurrency |
Currency of the initial amount. |
||||||||
interest * |
Information about product interest:
|
||||||||
entity |
Entity name. |
||||||||
external_id * |
Same as the _id field, but it is based on the external_id associated on the user credentials_token instead of the credentials_token. In case there is no external_id for the user, the value of this field is null. |
||||||||
limit * |
Available when type = "Confirming". The maximum amount of the liability contract. |
||||||||
periodicity * |
Payment periodicity of the liability. (daily, monthly, quarterly, annually, biannually). |
||||||||
subtype * |
Flanks Liability Subtype as indicated in the Liability Subtypes table. |
||||||||
updated_at_timestamp |
Last time when the liability was seen and the information was refreshed. |
Liability Types
API value |
Product description |
---|---|
Credit |
A line of credit, also known as a credit line, is an open-ended, revolving loan that a borrower may access on demand. |
Loan |
A loan is money, property, or other material goods given to another party in exchange for future repayment of the loan value amount with interest. |
Confirming |
Confirming is a financial service used to manage a company's payments to its suppliers. The financial institution that offers the Confirming advances the amount of the invoice in question to the supplier, who can collect this invoice in advance by financing it before its due date. |
Liability Subtypes
Liability type |
Liability Subtype |
|
---|---|---|
Loan |
mortgage |
Loans that are secured with real estate or personal property. |
Loan |
others |
Any other type of loan |
Liability Transactions
Field |
Description |
---|---|
_id |
Unique identifier for the liability. |
entity |
Name of the entity where the credentials belongs to. |
amount |
Total cash amount of the transaction. |
currencyAmount |
ISO currency of the amount |
balance |
Pending balance after the transaction |
currencyBalance |
ISO currency of the balance |
description |
Concept of the transaction. |
operationDate |
Date when the transaction was ordered. |
valueDate |
Date when the transaction was received |
liability_id |
Unique ID of the liability. |
credit_account * |
Current account associated with the transaction. |
interest * |
Unterest amount associated with the operation. |
commission * |
The transaction fee. |
external_id * |
Same as the _id field, but it is based on the external_id associated on the user credentials_token instead of the credentials_token. In case there is no external_id for the user, the value of this field is null. |
type |
Liability transaction type. See reference in the Liability Transaction Types table. |
transaction_id * |
Id identifier for the transactions given by the bank. |
pair_transaction_id * |
For forex transactions. Relates pair transactions. |
order_id * |
Id identifier of the order belonging the transaction, given by the bank. |
Liability Transaction Types
Flanks liability transaction type |
Description |
---|---|
1 |
Loan Closing |
2 |
Loan Decrease |
3 |
Loan Extension |
4 |
Loan Increase |
5 |
Loan Interest |
6 |
Loan Opening |
7 |
Loan Rate Change |
8 |
Loan Early Closing |
Cards
Field |
Description |
---|---|
_id |
Unique ID for the card. |
external_id * |
Same as the _id field, but it is based on the external_id associated on the user credentials_token instead of the credentials_token. In case there is no external_id for the user, the value of this field is null. |
entity |
Name of the entity where the credentials belongs to. |
product * |
Product description. |
contractNumber * |
Contract number associated to the card. |
pan |
Pan number of the card. Only the last four digits will be unmasked (*******1234) |
emissionDate * |
Emission date of the card. |
expirationDate * |
Date of card expiration. |
availableBalance * |
In case of credit amount not consumed. |
cardType |
Will be |
updated_at_timestamp |
Last time when the card was seen and the information was refreshed. |
Card transactions
Field |
Description |
---|---|
_id |
Unique ID for the transaction. |
card_id |
Unique ID for the card used to make the transaction. |
operationDate |
Date of operation when the transaction was ordered. |
valueDate |
Date when the operation was received. |
amount |
Total cash amount of the transaction. |
commission * |
Commission fee of the transaction. |
currency |
Currency of the transaction. |
shop * |
Shop name or transaction description. |
category * |
Category of the movement set by the bank. |
entity |
Flanks api entity identifier. |
external_id * |
Same as the _id field, but it is based on the external_id associated on the user credentials_token instead of the credentials_token. In case there is no external_id for the user, the value of this field is null. |
Identity
Field |
Description |
---|---|
_id |
Same as credentials token identifying online banking credentials. |
name * |
First name of the owner of the online banking credentials. |
surname1 * |
First surname of the owner of the online banking credentials. |
surname2 * |
Last name of the owner of the online banking credentials. |
fullName * |
Complete name of the owner of the online banking credentials. |
birthDate * |
Date of birth of the owner of the online banking credentials. |
address * |
Postal address for the owner of the bank access. Any of the values inside can be null. |
contactInfo * |
Email and/or phone contact information. |
identityDocument * |
Document number. |
gender * |
Can be |
occupation * |
Job category of the owner of the online banking credentials, see types in the Occupation Field table. |
sector * |
Laboral sector of the owner of the online banking credentials. Standarized type listed in the Sector Field table. |
* Can be null
Occupation field
API Value |
Meaning |
---|---|
Funcionario o similar (militar, policía, notarios, registradores...) |
Civil servant or similar (military, police, notaries, registrars...) |
Funcionario no TGSS |
Civil servant not TGSS |
Pensionista |
Pensioner |
Trabajador por cuenta ajena |
Employed worker |
Desempleado |
Unemployed |
Estudiante |
Student |
Rentista |
Annuitant |
Ama de casa o similar |
Housewife or similar |
Trabajador por cuenta propia |
Self-employed |
Otros |
Other |
Sector field
API Value |
Meaning |
---|---|
Directores y gerentes empresas relacionadas con la minería y construcción |
Directors and managers of mining and construction related companies. |
Directores y gerentes sector público |
Directors and managers in the public sector |
Artes |
Arts |
Deportes |
Sports |
Otros directores y gerentes |
Other directors and managers |
Técnicos y profesionales relacionados con la ingeniería (actividad de construcción y obra civil, arquitectos, urbanistas) |
Technicians and professionals related to engineering (construction and civil works activities, architects, town planners) |
Técnicos y procesionales del derecho público, tasaciones, inmobiliarias, aduanas y emisión y control de licencias |
Technicians and professionals related to public law, appraisals, real estate, customs, licensing and license issuance and control |
Técnicos y asesores financieros y en inversiones |
Financial and investment technicians and advisors |
Otros técnicos y profesionales científicos e intelectuales |
Other scientific and intellectual technicians and professionals |
Empleados de casas de apuestas, juego, galerías de arte, empeños, préstamos y deudas |
Gambling, gaming, art gallery, pawn, pawnbroker, loan and debt employees |
Empleados de oficina (que atienden o no al público) |
Clerical workers (whether or not they serve the public) |
Trabajadores de servicios |
Service workers |
Trabajadores cualificados en el sector agrícola, ganadero, forestal y pesquero |
Skilled agricultural, livestock, forestry and fishing workers |
Trabajadores cualificados de las industrias metalurgicas |
Skilled workers in metalworking industries |
Viajes y turismo |
Travel and tourism |
Trabajadores cualificados de la construcción, excepto operadores de máquinas |
Skilled workers in construction, except machine operators |
Trabajadores cualificados de las industrias manufactureras relacionadas con la joyería/sastrería |
Skilled workers in manufacturing industries related to jewellery/tailoring |
Otros trabajadores cualificados de las industrias manufactureras, excepto operadores de instalaciones y máquinas |
Other skilled workers in manufacturing industries, except plant and machine operators |
Otros |
Others |
Comercial |
Commercial |
Trabajadores no cualificados |
Unskilled workers |
Ocupaciones militares |
Military occupations |
Address streetType field
API Value |
Meaning |
---|---|
Acera |
Sidewalk |
Aeropuerto |
Airport |
Agregado |
Attaché |
Alameda |
Alameda |
Aldea |
Village |
Andén |
Platform |
Angosta |
Narrow |
Apartado de correos |
Post Office Box |
Apartamento |
Apartment |
Arrabal |
Arrabal |
Arroyo |
Arroyo |
Autopista |
Highway |
Autovía |
Highway |
Avenida |
Avenue |
Bajada |
Bajada |
Barranco |
Ravine |
Barriada |
Barriada |
Barrio |
Neighborhood |
Bloque |
Block |
Bulevar |
Boulevard |
Calle |
Street |
Callejón |
Alley |
Calzada |
Driveway |
Camino |
Road |
Camino viejo |
Old road |
Campo |
Field |
Canal |
Canal |
Canellón |
Canellón |
Cañada |
Cañada |
Carreta |
Cart |
Carretera |
Road |
Carril |
Lane |
Caserío |
Farmhouse |
Cava |
Cava |
Cavorco |
Cavorco |
Centro Comercial |
Commercial Center |
Chalet |
Villa |
Colegio |
School |
Colonia |
Colony |
Conjunto |
Set |
Contrapuerta |
Backdoor |
Coguiña |
Coguiña |
Corredera |
Sliding |
Corredora |
Corridor |
Corregidor |
Reeve |
Costanilla |
Waterfront |
Cuesta |
Slope |
Desconocida |
Unknown |
Diputación |
County council |
Diseminador |
Disseminator |
Edificio |
Building |
Entrada |
Entrance |
Escalinata |
Staircase |
Esquina |
Corner |
Explanada |
Esplanade |
Extramuros |
Outsidewalls |
Extrarradio |
Extraradius |
Ferrocarril |
Railroad |
Finca |
Farm |
Glorieta |
Gloriette |
Gran Vía |
Great Way |
Grupo |
Group |
Huerta |
Orchard |
Jardines |
Gardens |
Lado |
Side |
Lugar |
Place |
Manzana |
Block |
Masía |
Farmhouse |
Mediador |
Mediator |
Mercado |
Market |
Monte |
Mount |
Muelle |
Pier |
Municipio |
Township |
Otros conceptos |
Other |
Parcela |
Plot |
Parque |
Park |
Partida |
Partida |
Pasadizo |
Passageway |
Pasador |
Corridor |
Pasaje |
Passage |
Paseo |
Walkway |
Pasillo |
Aisle |
Playa |
Beach |
Plaza |
Square |
Plazoleta |
Square |
Plazuela |
Square |
Poblado |
Village |
Polígono |
Polygon |
Polígono Industrial |
Industrial park |
Portada |
Home |
Portal |
Portal |
Pórtico |
Gantry |
Portillo |
Portillo |
Portón |
Gate |
Postigo |
Shutter |
Postrigo |
Post wheat |
Prolongación |
Prolongation |
Puente |
Bridge |
Puerta |
Gate |
Quinta |
Fifth |
Ramal |
Branch |
Rambla |
Boulevard |
Regato |
Regato |
Residencial |
Residential area |
Ribera |
Riverside |
Rincón |
Corner |
Ronda |
Round |
Rotonda |
Traffic circle |
Rua |
Rua |
Salida |
Exit |
Sector |
Sector |
Senda |
Path |
Solar |
Site |
Subida |
Uphill |
Terrenos |
Land |
Torrente |
Torrent |
Travesía |
Traverse |
Urbanización |
Urbanization |
Vereda |
Trail |
Vía |
Road |
Vía Pública |
Public Road |
Vial |
Road |
Holders
Field |
Description |
---|---|
product_name |
General name of the product. |
name |
Holder name. |
product_id |
_id corresponding to the returned in /account, /card, /portfolio or /liability |
rel |
Holder relation, see more in Relation Types table. |
external_id * |
Only for technology provider case. In case there is no alias for the user, the value of this field is null. |
Relation types
API Value |
Meaning |
---|---|
Titular |
Holder |
Autorizado |
Authorized |
Representante |
Representative |
Aut.Online |
Online authorized |
Apoderado |
Proxy |
Depositante |
Depositor |
Propietario |
Owner |
Administrador /Rep Leg Jurid |
Administrator |
Firma |
Signature |
Derechohabiente |
Applicant |
Garante |
Guarantor |
Participe |
Participant |
Tutor |
Guardian |
Firmante Póliza |
Policy signer |
Cotitular |
Co-Holder |
Usufructuario |
Usufructuary |
Otros |
Others |
All credential's data
Field |
Description |
---|---|
cards |
Information regarding cards including owners (with relation) and transactions for each card. |
accounts |
Response of /credentials/account including owners (with relation) and its associated transactions. |
portfolios |
response of /portfolio including owners (with relation). |
fidexIncome |
investments of type FI with its transactions. |
funds |
investments of type F with its transactions. |
liabilities |
response of /credentials/liability including owners (with relation) and its associated transactions. |
pensionPlans |
investments of type PP with its transactions. |
stocks |
response of /investment filtered by investment. Type equals to VI with its transactions. |
etfs |
investments of type ETF with its transactions. |
deposits |
actually empty as the deposit will be included under the key "bankProducts". |
others |
investments of type O with its transactions. |
identity |
response of credentials/auth. |
liquidity |
investments of type L with its transactions. |
cryptoCurrencies |
investments of type C with its transactions. |
contractForDifferences |
investments of type CFD with its transactions. |
derivatives |
investments of type DV with its transactions. |
bankProducts |
investments of type BP with its transactions. |
alternativeEmergingProducts |
investments of type AEP with its transactions. |
updated_at_timestamp |
last time when a product was seen and the information was refreshed |
Entities
Field |
Description |
---|---|
id |
Flanks internal financial entity identifier |
name |
Financial entity name |
cif |
Entity VAT number |
alwaysManualRefresh |
is set to true when the entity ask for 2FA on every login |