Asset Information

GET 
/companies/:companyID/assets/:asset_id

Asset Information

Request

Path Parameters

asset_id uuidrequired

Responses

200

the asset information

application/json

Schema

Schema

id stringrequired

The unique identifier of the asset

name stringrequired

The name of the asset

accountNumber stringnullable

The BBAN of the asset

group stringrequired

Possible values: [banking, securities, lifeInsurance_capitalization, retirement_employee, crowdfunding, private_equity, direct_registered_account, crypto, benefits, heritage_real_estate, professional_real_estate, commercial_real_estate, real_estate_tax_relief, financial_tax_relief, agricultural_tax_relief, other, rock_paper, exotic, home_loan, business_loan, consumer_loan, other_loan, unrecognized]

The group of the asset. Note that the group will determine the structure of the asset's metadata

management stringrequired

Possible values: [under, none]

The management of the asset, under if the assets is managed by the company, otherwise none

distribution

object[]

required

Array [

ownership numberrequired

entityId uuidrequired

]

providers

object

nullable

Provider IDs associated with the asset. Each key represents a provider name and the value is the provider-specific ID for this asset.

property name* string

productCatalogue

object

nullable

Product catalogue information linked to this asset

id uuidrequired

The product catalogue ID (coalesce of parentCatalogueId or catalogue.id)

name stringnullable

Product name (coalesce: referential.name, catalogue.catalogueName)

insurerId uuidnullable

The insurer/partner institution ID

insurerName stringnullable

The insurer/partner institution name

productType stringnullable

The type of the product

valuation numbernullable

The current valuation of the asset

valuationDate stringnullable

The date of the asset's current valuation

openingDate stringnullable

The contract opening date of the asset

closingDate stringnullable

The closing date of the asset's contract, if any

totalInvestment numbernullable

The total amount invested into the asset

totalDisinvestment numbernullable

The total amount disinvested from the asset

investments

object[]

nullable

The list of investments (supports) held within this contract

Array [

support

object

nullable

id stringrequired

The support ID of the investment

code stringrequired

The support code of the investment

name stringrequired

The support name of the investment

supportType stringrequired

The support type of the investment

isin stringnullable

The ISIN of the investment, if any

label stringnullable

The label/name of the support

quantity numbernullable

The number of owned Unit of Accounts

unitValue numbernullable

The value of one Unit of Account, in euros

unitPrice numbernullable

The price of one Unit of Account, in euros

valuation numbernullable

The valuation of the position, in euros

valuationDate stringnullable

The valuation date of the investment

instrument stringnullable

The type of financial instrument

category stringnullable

The category of the investment

subcategory stringnullable

The subcategory of the investment

managementCompany stringnullable

The management company of the support

riskIndicator numbernullable

The risk indicator of the support

sri numbernullable

The Synthetic Risk Indicator (SRI) of the support

performance

object

nullable

gain

object

required

value numberrequired

The gain value of the investment, in euros

percentage numberrequired

The gain percentage of the investment

]

Example (from schema)

{
  "id": "adfdfaca-48f0-4f3b-b30a-c6d97293090c",
  "name": "Jean dupont",
  "accountNumber": "string",
  "group": "banking",
  "management": "under",
  "distribution": [
    {
      "ownership": 0,
      "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "providers": {
    "provider1": "id1",
    "provider2": "id2"
  },
  "productCatalogue": {
    "id": "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
    "name": "Cardif Elite Retraite",
    "insurerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "insurerName": "CARDIF",
    "productType": "string"
  },
  "valuation": 0,
  "valuationDate": "string",
  "openingDate": "string",
  "closingDate": "string",
  "totalInvestment": 0,
  "totalDisinvestment": 0,
  "investments": [
    {
      "support": {
        "id": "string",
        "code": "string",
        "name": "string",
        "supportType": "string"
      },
      "isin": "string",
      "label": "APPLE INC",
      "quantity": 0,
      "unitValue": 0,
      "unitPrice": 0,
      "valuation": 15575,
      "valuationDate": "string",
      "instrument": "Stock",
      "category": "Equity",
      "subcategory": "Technology",
      "managementCompany": "BlackRock",
      "riskIndicator": 3,
      "sri": 4,
      "performance": {
        "gain": {
          "value": 0,
          "percentage": 0
        }
      }
    }
  ]
}

Loading...