Create a new valuation for an entity

post/entities/{id}/valuation

Add a new valuation to the entity's history

Path ParametersExpand Collapse

id: string

Body ParametersExpand Collapse

directly_held_assets: array of object { asset_class_id, display_name, value, external_id }

List of assets to include in this valuation

asset_class_id: string

Asset class ID to associate with this asset

display_name: string

Display name of the asset

value: number

Value of this asset in USD

formatdouble

external_id: optional string

External ID for the asset

effective_date: string

The date this valuation is effective

formatdate

description: optional string

Free-form notes about this valuation

maxLength2048

ReturnsExpand Collapse

Valuation = object { id, created_at, directly_held_asset_value, 6 more }

id: string

Unique identifier with valuationv2_ prefix

created_at: string

Timestamp when the valuation was created

formatdate-time

directly_held_asset_value: number

Total value of all directly held assets in USD

formatdouble

directly_held_assets: array of object { id, asset_class, display_name, 2 more }

List of individual assets in this valuation

id: string

Asset ID

asset_class: object { id, display_name }

id: string

Asset class ID

display_name: string

Display name of the asset class

display_name: string

Display name of the asset

value: number

Value of this asset in USD

formatdouble

external_id: optional string

External ID from the static asset (if available)

effective_date: string

The date this valuation is effective

formatdate

entity_id: string

Entity ID this valuation belongs to

total_value: number

Total value of all assets minus liabilities in USD

formatdouble

updated_at: string

Timestamp when the valuation was last updated

formatdate-time

description: optional string

Free-form notes about this valuation

maxLength2048

Create a new valuation for an entity

curl https://$WITHLUMINARY_SUBDOMAIN.withluminary.com/api/public/v1/entities/$ID/valuation \
    -H 'Content-Type: application/json' \
    -d '{
          "directly_held_assets": [
            {
              "asset_class_id": "asset_class_01ARZ3NDEKTSV4RRFFQ69G5FAV",
              "display_name": "Apple Inc. Stock",
              "value": 50000
            }
          ],
          "effective_date": "2024-01-15"
        }'

{
  "id": "valuationv2_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "created_at": "2024-01-15T09:30:00Z",
  "directly_held_asset_value": 1000000,
  "directly_held_assets": [
    {
      "id": "assetv2_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "asset_class": {
        "id": "asset_class_01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "display_name": "Equities"
      },
      "display_name": "Apple Inc. Stock",
      "value": 50000,
      "external_id": "AAPL-12345"
    }
  ],
  "effective_date": "2024-01-15",
  "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "total_value": 1000000,
  "updated_at": "2024-01-20T14:45:00Z",
  "description": "description"
}

Returns Examples

{
  "id": "valuationv2_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "created_at": "2024-01-15T09:30:00Z",
  "directly_held_asset_value": 1000000,
  "directly_held_assets": [
    {
      "id": "assetv2_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "asset_class": {
        "id": "asset_class_01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "display_name": "Equities"
      },
      "display_name": "Apple Inc. Stock",
      "value": 50000,
      "external_id": "AAPL-12345"
    }
  ],
  "effective_date": "2024-01-15",
  "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "total_value": 1000000,
  "updated_at": "2024-01-20T14:45:00Z",
  "description": "description"
}