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

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"
  }
}

Loading...