Labs Data Extensions

Labs fields let us expose experimental attributes before they become part of the core portfolio, account, or investment payloads. Every labs attribute is delivered beneath the labs object on the corresponding resource (for example portfolio.labs.customer.name). These properties are optional and may change as the feature graduates; rely on the descriptions below to understand the current structure.

Working With Labs Data

• Labs fields are additive. They never remove or rename existing available fields.
• A labs object may be absent or partially populated when the upstream institution does not provide the data.
• Once a labs field becomes part of the stable model, the entry remains available for a grace period so you can migrate.
• Treat numeric values as raw amounts unless a unit is specified in the description.
• Any product may contain an extra key under labs. This is a free-form dictionary populated with institution-specific fields that do not fit any standardized labs key. Its contents are not fixed and vary by institution.

Portfolio Labs Fields

customer

Field	Type	Description
name *	str	Customer name as provided by the institution.
type *	str	Indicates whether the customer is physical or juridical.

* Can be null

pension_plan

Field	Type	Description
birth_date *	str	Birth date of the plan holder.
policy_number *	str	Contract reference supplied by the pension provider.
product_provider *	str	Name of the company offering the plan.
retirement_options *	str	High-level description of permitted retirement options.
retirement_suboptions *	str	Additional detail for the retirement options.
retirement_age *	int	Target retirement age for the plan.
fund_charges *	float	Annualized fund fees.
adviser_charges *	float	Adviser fees attached to the plan.
platform_charges *	float	Platform-level fees.
total_contributions *	float	Lifetime contributions made to the plan.
initial_date *	str	Contract start date.
valuation_date *	str	Date of the latest valuation.
uk	{}	Additional attributes for UK wrappers (see below).

* Can be null

pension_plan.uk

Field	Type	Description
type *	str	Wrapper-specific plan type (SIPP, RIA, ISA, GIA, PIMS, or Other).
employer_contributions *	float	Amount funded by the employer.
employee_contributions *	float	Amount funded by the employee.
partially_transferable *	bool	Indicates if part of the funds can be transfered to another Plan.
tax_relief *	float	Tax relief credited to the plan.
transfer_value *	float	Lump-sum transfer value.
crystallised *	float	Amount already crystallised.
fund_status *	str	Accepts "Crystallised", "Uncrystallised", "Partially crystallised".
plan_value *	float	Current value of the wrapper.
transfer_charges *	float	Fees for transfering the PP to another provider.
flexible_drawdown *	bool	Indicates if the plan allows for income to be withdrawn flexibly.
policyserving_charges *	float	Administration maintenance fees.
beneficiary_nominated *	str	Beneficiary nominated for death benefits.
beneficiary_relation *	str	Relationship of the beneficiary to the holder.
other_charges *	float	Other charges related to the pension plan.
paid_up_date *	str	Date when the policy stopped receiving contributions.

* Can be null

assurance_vie

Field	Type	Description
insurer *	str	Insurance company issuing the contract.
beneficiaries	[str]	List of designated beneficiaries.
pledge *	bool	Indicates if the contract is pledged.
pledge_ratio *	float	Portion of the contract that is pledged.
broker *	str	Broker associated with the contract.
custodian *	str	Custodian handling the assets.
management_fees *	float	Annual management fees.
insurance_manager *	str	Name of the insurance manager.
management_mode *	str	Portfolio management style (Horizon, Mandat, Dédiée, Libre, Pilotée, Profilée, or Conseillée).
paid_premium *	float	Total premiums paid.
historical_performance *	float	Historical return of the contract.
subscriber_birth_date *	str	Subscriber date of birth.
contract_duration *	int	Duration in years.
initial_date *	str	Contract start date.
valuation_date *	str	Latest valuation date.
contract_status *	str	Current status of the contract (active, closing, closed, or transferred).
close_date *	str	Date when the contract closed, if applicable.
management_profile *	str	Risk profile set by the provider (prudent, balanced, dynamic, or offensive).

* Can be null

per

Field	Type	Description
beneficiaries	[str]	Beneficiary list for the PER contract.
pledge *	bool	Indicates if the contract is pledged.
pledge_ratio *	float	Portion pledged.
management_mode *	str	Management strategy (Horizon, Mandat, Dédiée, Libre, Pilotée, Profilée, or Conseillée).
birth_date *	str	Participant birth date.
exit_mode *	str	Exit option chosen for the contract (capital or rente).
type *	str	Contract type (bancaire or assurance).
deductible_payments *	bool	Indicates whether contributions are deductible.
funding_type *	str	Origin of the contributions.

* Can be null

pea and pea-pme

Field	Type	Description
pledge *	bool	Indicates if the plan is pledged.
pledge_ratio *	float	Portion pledged.
management_mode *	str	Management strategy (Horizon, Mandat, Dédiée, Libre, Pilotée, Profilée, or Conseillée).
eligible_assets *	[str]	Assets eligible under the plan rules.
opening_date *	str	Account opening date.
deposit_limit *	float	Contribution cap.

* Can be null

cto

Field	Type	Description
pledge *	bool	Indicates if the account is pledged.
pledge_ratio *	float	Portion pledged.
management_mode *	str	Management strategy (Horizon, Mandat, Dédiée, Libre, Pilotée, Profilée, or Conseillée).
broker *	str	Introducing broker.

* Can be null

contrat_capitalisation

Field	Type	Description
insurer *	str	Insurer name.
pledge *	bool	Indicates if the contract is pledged.
pledge_ratio *	float	Portion pledged.
broker *	str	Broker associated with the contract.
custodian *	str	Custodian handling the assets.
management_fees *	float	Annualized fees.
insurance_manager *	str	Insurance manager name.
management_mode *	str	Management strategy (Horizon, Mandat, Dédiée, Libre, Pilotée, Profilée, or Conseillée).
paid_premium *	float	Total premiums paid.
historical_performance *	float	Historical return.
contract_duration *	int	Contract length in years.

* Can be null

FIS, FAS, FIC, FID

Dynamic keys mirroring the underlying French fund type.

Field	Type	Description
pledge *	bool	Indicates if the fund is pledged.
pledge_ratio *	float	Portion pledged.
management_mode *	str	Management strategy (Horizon, Mandat, Dédiée, Libre, Pilotée, Profilée, or Conseillée).
lockin_period *	int	Lock-up period in years.

* Can be null

ref_accounts_ids

Field	Type	Description
ref_accounts_ids *	[str]	Internal account identifiers linked to this portfolio wrapper.

* Can be null

extra

Field	Type	Description
(any key) *	any	Custom fields populated with institution-specific data not covered by any standardized labs key. Contents vary by institution.

* Can be null

Account Labs Fields

customer

Field	Type	Description
name *	str	Customer name when provided by the institution.
type *	str	Indicates whether the account belongs to a physical or juridical customer.

* Can be null

portfolio_id

Field	Type	Description
portfolio_id *	str	Identifier of the linked portfolio when the account is attached to one.

* Can be null

included_in_portfolio_balance

Field	Type	Description
included_in_portfolio_balance	bool	true when the account balance is already counted in the balance of the portfolio it is linked to (e.g. the cash account of a PEA), so it must not be added again. false when the account balance is independent.

interest_rate

Field	Type	Description
interest_rate	float	Interest rate applied to the account, when disclosed by the institution.

French savings products (livret_A, PEL, CEL, CELP, CSL, LDDS, LEP, LI, LJ)

Each key represents the corresponding savings product payload.

Field	Type	Description
eligibility_conditions *	str	Text describing who can open the product.
taxation *	float	Applicable tax rate.
deposit_limit *	float	Maximum allowed balance or contributions.

* Can be null

valuation_date

Field	Type	Description
valuation_date *	str	Date of the latest account valuation when provided by the institution.

* Can be null

extra

Field	Type	Description
(any key) *	any	Custom fields populated with institution-specific data not covered by any standardized labs key. Contents vary by institution.

* Can be null

Card Labs Fields

limit

Field	Type	Description
limit *	float	Credit limit of the card, when disclosed by the institution. Only populated for credit cards.

* Can be null

used_balance

Field	Type	Description
used_balance *	float	Outstanding balance already drawn on the card (used credit), as a positive amount. Only populated for credit cards.

* Can be null

extra

Field	Type	Description
(any key) *	any	Custom fields populated with institution-specific data not covered by any standardized labs key. Contents vary by institution.

* Can be null

---

Liability Labs Fields

portfolio_id

Field	Type	Description
portfolio_id *	str	Identifier of the portfolio the liability hangs from, when the institution discloses the link. Matches the _id of that portfolio.

* Can be null

extra

Field	Type	Description
(any key) *	any	Custom fields populated with institution-specific data not covered by any standardized labs key. Contents vary by institution. For UBS Switzerland it carries parent_account_number, the account reference of the parent portfolio exactly as the institution writes it in its master file.

* Can be null

---

Investment Labs Fields

pension_plan

Field	Type	Description
policy_number *	str	Plan policy reference.
retirement_age *	int	Target age for withdrawals.
fund_charges *	float	Annualized fund fees.
total_contributions *	float	Lifetime contributions.
uk	{}	Additional fields for UK securities (see below).

* Can be null

pension_plan.uk

Field	Type	Description
employer_contributions *	float	Employer-funded amount.
employee_contributions *	float	Employee-funded amount.
partially_transferable *	bool	Indicates if transfers out are restricted.
tax_relief *	float	Tax relief credited.
sedol	str	SEDOL identifier for the pension security.

* Can be null

sedol

Field	Type	Description
sedol *	str	Security identifier provided when the instrument has a SEDOL.

* Can be null

scpi

Field	Type	Description
type *	str	SCPI type.
management_company *	str	Managing company.
capital_structure *	str	Capital structure of the fund (fixed or variable).
inception_date *	str	Fund inception date.
redemption_value *	float	Redemption value per share.
subscription_price *	float	Subscription price.
minimum_subscription_amount *	float	Minimum commitment allowed.
distribution_frequency *	str	Frequency of distributions.
distribution_yield *	str	Yield description or percentage.
internal_rate_of_return *	int	Provided IRR.
market_capitalization *	str	Market capitalization text.
shareholders_number *	int	Number of shareholders.
recommended_holding_period *	int	Recommended holding period (years).
subscription_fees *	float	Subscription fees.
management_fees *	float	Management fees.
risk_level *	int	Risk scale reported by the provider.
geographic_allocation *	str	Description of the geographic allocation.
sector_allocation *	str	Description of the sector allocation.
financial_occupancy_rate *	float	Financial occupancy rate.
assets_under_management *	str	Assets under management text.
leverage *	float	Leverage ratio.
life_ensurance_eligibility *	bool	Eligibility for life insurance wrappers.
applicable_tax_regime *	str	Tax regime description.

* Can be null

sci

Field	Type	Description
company_registration_number *	str	Registration number of the company.
registered_office_address *	str	Official registered address.
corporate_purpose *	str	Corporate purpose statement.
incorporation_date *	str	Incorporation date.
manager_name *	str	Manager name.
partners	[str]	Partner names (may be empty).
type *	str	SCI type.
share_capital *	float	Share capital.
form_of_contribution *	str	Description of contributions.
asset_valuation *	float	Asset valuation.
number_and_nature_of_properties *	str	Properties covered by the SCI.
debt_level *	float	Debt level.
gross_net_rental_yield *	float	Rental yield.
share_of_profit *	float	Share of profit.
taxation_regime *	str	Tax regime.
occupancy_rate *	float	Occupancy rate.
net_book_value *	float	Net book value.
partner_taxation *	str	Tax treatment for partners.
donation_usufruct_eligibility *	str	Eligibility details for donations or usufruct.
fiscal_year_end *	str	Fiscal year end text.

* Can be null

structured_product

Field	Type	Description
issue_price *	float	Initial issue price.

* Can be null

depot_a_terme

Field	Type	Description
early_redemption_conditions *	str	Qualifying conditions for early redemption.
early_redemption_penalty *	bool	Indicates whether penalties apply on early exit.
renewal_method *	str	Method used when renewing the term deposit.
interest_rate_type *	str	Type of interest rate (fix or variable).
initial_amount *	float	Principal deposited when the term deposit was opened.
accrued_interest_date *	str	Date as of which the accrued interest is computed.
next_interest_payment_date *	str	Next scheduled interest payment date.
last_interest_payment_date *	str	Last scheduled interest payment date.

* Can be null

fonds_euro

Field	Type	Description
capital_guarantee *	str	Details on the capital guarantee.
redemption_mode *	str	Redemption mode description.
profit_sharing *	float	Profit-sharing rate.
guaranteed_minimum_return *	float	Guaranteed minimum return.

* Can be null

option

Field	Type	Description
underlying_asset_symbol	str	Symbol of the underlying instrument.
underlying_asset_isin *	str	ISIN of the underlying instrument, when available.
strike_price	float	Strike price.
expiration_date	str	Expiration date.
type	str	Option type (PUT or CALL).
multiplier	float	Contract multiplier (defaults to 100).
market *	str	ISO MIC code (ISO 10383) of the market where the option trades.

* Can be null

warrant

Field	Type	Description
underlying_asset_symbol	str	Symbol of the underlying instrument.
strike_price	float	Strike price.
expiration_date	str	Expiration date.
type	str	Warrant type (PUT or CALL).
issuer *	str	Issuer name.
conversion_rate *	float	Conversion rate.
nature *	str	Exercise style (european or american).

* Can be null

future

Field	Type	Description
underlying_asset_symbol *	str	Symbol of the underlying asset.
price *	float	Contract price.
expiration_date *	str	Expiration date.

* Can be null

forex_option

Field	Type	Description
underlying_asset_symbol	str	Symbol of the currency pair.
strike_price	float	Strike price.
expiration_date	str	Expiration date.
type	str	Option type (PUT or CALL).
base_currency	str	ISO 4217 code of the base currency.
quote_currency	str	ISO 4217 code of the quote currency.
nature *	str	Exercise style (european or american).

* Can be null

private_equity

Field	Type	Description
capital_called *	float	Total capital called.
capital_committed *	float	Total capital committed.
capital_distribution *	float	Capital returned to investors.
capital_pending *	float	Committed capital not yet called.
recallable_distributions *	float	Distributions the manager can call again.
tvpi *	float	Total value to paid-in of the client, as reported by the institution.
dpi *	float	Distributed to paid-in of the client, as reported by the institution.
rvpi *	float	Residual value to paid-in of the client, as reported by the institution.
net_irr *	float	Net IRR of the client, as a percentage.
management_fees_gross *	float	Management fees before offsets, waivers and rebates.
management_fees *	float	Management fees net of offsets, waivers and rebates.
fund_expenses *	float	Fund expenses allocated to the investor.
carried_interest *	float	Carried interest accrued, earned or paid.
nav_gross_of_carry *	float	NAV before carried interest. balance is the NAV net of carry.
unit_price *	float	Current unit price.
share_class *	str	Share class held, as named by the institution.
pe_vehicle_type *	str	Vehicle category (fund_of_funds, coinvestment, or direct).
pe_legal_form *	str	Legal wrapper (scr, fcr, slp, lp, or other).
valuation_type *	str	Valuation basis: valuation is an official NAV, proforma an estimate.
program_id *	str	Programme the vehicle belongs to, when the institution groups them.
pe_underlying *	[{}]	List of underlying funds and their companies (see below).

* Can be null

Fee, carry and recallable fields are cumulative since inception, reported as positive amounts in the position currency. balance remains the NAV net of carried interest.

private_equity.pe_underlying

Each entry groups the portfolio companies behind one underlying fund, or the companies the vehicle holds directly, in which case the fund fields are null. Amounts prefixed with fund_ belong to the underlying fund, not to the position.

Field	Type	Description
fund_id *	str	Fund identifier. Null when the vehicle holds the companies directly.
fund_name *	str	Fund name. Null when the vehicle holds the companies directly.
scope	str	Whose amounts these are (peip_aggregate for the programme, or client).
fund_type *	str	Fund category (primary, secondary, or coinvestment).
fund_strategy *	str	Investment strategy declared by the manager.
main_focus *	str	Main geography of the fund.
investment_date *	str	Date the fund was entered (YYYY-MM-DD).
quarter *	str	Reference date of the reported figures (YYYY-MM-DD).
fund_size *	float	Total size of the fund.
fund_committed *	float	Capital committed to the fund by the manager.
fund_drawdown *	float	Capital drawn down by the fund.
fund_pending *	float	Commitment not yet drawn down.
manager_percentage *	float	Manager's weight in the fund, as a percentage.
fund_valuation *	float	Valuation of the manager's stake in the fund.
fund_distributed *	float	Distributions received by the manager.
fund_capital_calls *	float	Capital contributed by the manager.
fund_total_value *	float	Sum of fund_valuation and fund_distributed.
fund_tvpi *	float	Total value to paid-in of the fund.
fund_dpi *	float	Distributed to paid-in of the fund.
fund_rvpi *	float	Residual value to paid-in of the fund.
companies	[{}]	List of the portfolio companies of the fund (see below).

* Can be null

private_equity.pe_underlying.companies

Field	Type	Description
company	str	Company name.
previous_names *	[str]	Former names the company was known by.
sector *	str	Business sector.
country *	str	Country of the company.
purchase_date *	str	Date the fund entered the company (YYYY-MM-DD).
invested *	float	Amount invested in the company by the fund.
moic *	float	Multiple on invested capital reported by the manager.
manager_opinion *	str	One of strong_positive, on_plan, neutral, watchlist, or at_risk.
ownership_pct *	float	Percentage of the company held.
irr *	float	IRR of the investment in the company, as a percentage.
fair_value *	float	Current fair value of the stake in the company.
realized_value *	float	Value already realized from the company.
status *	str	One of active, exit, or write_off.
exit_date *	str	Date the fund exited the company (YYYY-MM-DD).
web *	str	Corporate website.
description *	str	Description of the business.

* Can be null

real_estate

Field	Type	Description
funded *	float	Amount funded.
funded_date *	str	Date of funding.
property *	{}	Details of the underlying property (see below).
acquisition_price *	float	Purchase price of the property.
acquisition_date *	str	Date the property was acquired.
cadastral_reference *	str	Official cadastral/land-registry reference.
asset_type *	str	Property category (e.g. residential, commercial).
address *	str	Street address.
zip_code *	str	Postal code.
municipality *	str	City or municipality.
province *	str	Province or region.
floor_area_m2 *	float	Usable floor area in square metres.
ownership_percentage *	float	Ownership share (0–100).
annual_rent *	float	Gross rent collected per year, in the investment currency.
annual_expenses *	float	Yearly running costs (taxes, upkeep, insurance), sign as reported.
usage *	str	How the asset is used, as labelled by the source (e.g. rented, vacant).
tenant *	str	Current tenant as reported by the source.
contract_expiration *	str	End date of the current lease contract (YYYY-MM-DD).
country *	str	Country where the property is located.
geographic_zone *	str	Regional bucket assigned by the source (e.g. developed Europe).
wault *	float	Weighted Average Unexpired Lease Term in years, as reported by the source.

* Can be null

real_estate.property

Field	Type	Description
price *	float	Purchase price.
valuation *	float	Latest valuation.
location *	str	Location of the property.
rented *	bool	Indicates if the property is rented (defaults to false).
bedrooms *	int	Number of bedrooms.

* Can be null

crowdfunding

Field	Type	Description
status *	str	Project status (Funding, Active, Concluded, or Defaulted).
cf_type *	str	Crowdfunding type (Loan or Equity).
project_value *	float	Project value.
sponsor *	str	Project sponsor.
interest_payment_frequency *	str	Interest payment frequency.
interest_paid *	float	Interest paid to date.
principal_repayment_type *	str	When is the capital repaid (monthly, quarterly, at maturity... )

* Can be null

crowdlending

Field	Type	Description
status *	str	Loan status (Funding, Active, Late, Defaulted, Repurchased, or Concluded).
underlying_loan_type *	str	Type of the underlying loan (e.g. personal, business, real estate).
project_value *	float	Total value of the funded project or loan.
outstanding_principal *	float	Principal amount still pending repayment.
payments_received *	float	Amount of payments received to date.
pending_payments *	bool	Indicates if there are payments pending.
lending_entity *	str	Lending platform or entity servicing the loan.
issuer *	str	Issuer of the underlying loan.
collateral *	bool	Indicates if the loan is backed by collateral.

* Can be null

forex_forward

Field	Type	Description
settlement_date *	str	Settlement date of the forward contract.
base_currency	str	ISO 4217 code of the base currency.
quote_currency	str	ISO 4217 code of the quote currency.
forward_rate *	float	Agreed exchange rate for the forward contract.

* Can be null

extra

Field	Type	Description
(any key) *	any	Custom fields populated with institution-specific data not covered by any standardized labs key. Contents vary by institution.

* Can be null

Transaction-sourced labs fields

Labs keys below originate from investment transactions but are surfaced within investment payloads for convenience.

Field	Type	Description
account_number *	str	Cash account number used for the transaction when available.
cusip *	str	Transaction-level CUSIP when it differs from the ISIN.

* Can be null

Labs Data Example

Here is an example of what labs would look like under an Assurance Vie Portfolio:

{
    "id": "P12345Uttt",
    "balance": 40.1,
    "currency": "EUR",
    "name": "Assurance Vie Portfolio",
    "numOwners": 0,
    "owners": [],
    "refAccount": null,
    "refAccounts": [],
    "refValores": "12345",
    "type": null,
    "tax_type": null,
    "holders": [
        {
            "holder_name": "John Doe",
            "relation": "Titular"
        }
    ],
    "labs": {
        "customer": {
            "name": "John Doe",
            "type": "physical"
        },
        "assurance_vie": {
            "insurer": "insurer",
            "beneficiaries": [
                "Jane Doe",
            ],
            "pledge": true,
            "pledge_ratio": 0.4,
            "broker": "creditagricole",
            "custodian": "lcl",
            "management_fees": 0.01,
            "insurance_manager": "mr manager",
            "management_mode": "Libre",
            "paid_premium": 0.0,
            "historical_performance": 0.0,
            "subscriber_birth_date": "1965-01-01",
            "contract_duration": 30,
            "initial_date": "2000-01-01",
            "valuation_date": "2025-01-01",
            "contract_status": "active",
            "close_date": null,
            "management_profile": "offensive"
        }
    }
}