Skip to content
Luminary Luminary Luminary
Get started
API Reference

Entities

List all entities
client.entities.list(EntityListParams { household_id, kind, limit, offset } query?, RequestOptionsoptions?): EntityList { data, pagination }
get/entities
Delete an entity
client.entities.delete(stringid, RequestOptionsoptions?): void
delete/entities/{id}
Get an entity by ID
client.entities.retrieve(stringid, RequestOptionsoptions?): Entity { id, created_at, display_name, 4 more }
get/entities/{id}
ModelsExpand Collapse
Entity { id, created_at, display_name, 4 more }
id: string

Unique identifier with entity_ prefix

created_at: string

Timestamp when the entity was created

formatdate-time
display_name: string

Display name of the entity

household_id: string

Household ID this entity belongs to

kind: EntityKind

Type of entity - determines the specific subtype and applicable fields

Accepts one of the following:
"REVOCABLE_TRUST"
"IRREVOCABLE_TRUST"
"SLAT_TRUST"
"ILIT_TRUST"
"QPRT_TRUST"
"GRAT_TRUST"
"CRT_TRUST"
"CLT_TRUST"
"INDIVIDUAL_PERSONAL_ACCOUNT"
"JOINT_PERSONAL_ACCOUNT"
"CUSTODIAL_PERSONAL_ACCOUNT"
"INSURANCE_PERSONAL_ACCOUNT"
"QUALIFIED_TUITION_PERSONAL_ACCOUNT"
"RETIREMENT_PERSONAL_ACCOUNT"
"DONOR_ADVISED_FUND"
"PRIVATE_FOUNDATION"
"LLC_BUSINESS_ENTITY"
"LP_BUSINESS_ENTITY"
"GP_BUSINESS_ENTITY"
"SOLE_PROPRIETORSHIP_BUSINESS_ENTITY"
"SCORP_BUSINESS_ENTITY"
"CCORP_BUSINESS_ENTITY"
stage: "PRE_CREATED" | "AI_CREATING" | "AI_CREATION_FAILED" | 7 more

Lifecycle stage of the entity

Accepts one of the following:
"PRE_CREATED"
"AI_CREATING"
"AI_CREATION_FAILED"
"AI_NEEDS_REVIEW"
"DRAFT"
"READY_FOR_PROPOSAL"
"IMPLEMENTATION"
"ACTIVE"
"COMPLETED"
"ARCHIVED"
updated_at: string

Timestamp when the entity was last updated

formatdate-time
EntityKind = "REVOCABLE_TRUST" | "IRREVOCABLE_TRUST" | "SLAT_TRUST" | 19 more

Type of entity - determines the specific subtype and applicable fields

Accepts one of the following:
"REVOCABLE_TRUST"
"IRREVOCABLE_TRUST"
"SLAT_TRUST"
"ILIT_TRUST"
"QPRT_TRUST"
"GRAT_TRUST"
"CRT_TRUST"
"CLT_TRUST"
"INDIVIDUAL_PERSONAL_ACCOUNT"
"JOINT_PERSONAL_ACCOUNT"
"CUSTODIAL_PERSONAL_ACCOUNT"
"INSURANCE_PERSONAL_ACCOUNT"
"QUALIFIED_TUITION_PERSONAL_ACCOUNT"
"RETIREMENT_PERSONAL_ACCOUNT"
"DONOR_ADVISED_FUND"
"PRIVATE_FOUNDATION"
"LLC_BUSINESS_ENTITY"
"LP_BUSINESS_ENTITY"
"GP_BUSINESS_ENTITY"
"SOLE_PROPRIETORSHIP_BUSINESS_ENTITY"
"SCORP_BUSINESS_ENTITY"
"CCORP_BUSINESS_ENTITY"
EntityList { data, pagination }
data: Array<Entity { id, created_at, display_name, 4 more } >
id: string

Unique identifier with entity_ prefix

created_at: string

Timestamp when the entity was created

formatdate-time
display_name: string

Display name of the entity

household_id: string

Household ID this entity belongs to

kind: EntityKind

Type of entity - determines the specific subtype and applicable fields

Accepts one of the following:
"REVOCABLE_TRUST"
"IRREVOCABLE_TRUST"
"SLAT_TRUST"
"ILIT_TRUST"
"QPRT_TRUST"
"GRAT_TRUST"
"CRT_TRUST"
"CLT_TRUST"
"INDIVIDUAL_PERSONAL_ACCOUNT"
"JOINT_PERSONAL_ACCOUNT"
"CUSTODIAL_PERSONAL_ACCOUNT"
"INSURANCE_PERSONAL_ACCOUNT"
"QUALIFIED_TUITION_PERSONAL_ACCOUNT"
"RETIREMENT_PERSONAL_ACCOUNT"
"DONOR_ADVISED_FUND"
"PRIVATE_FOUNDATION"
"LLC_BUSINESS_ENTITY"
"LP_BUSINESS_ENTITY"
"GP_BUSINESS_ENTITY"
"SOLE_PROPRIETORSHIP_BUSINESS_ENTITY"
"SCORP_BUSINESS_ENTITY"
"CCORP_BUSINESS_ENTITY"
stage: "PRE_CREATED" | "AI_CREATING" | "AI_CREATION_FAILED" | 7 more

Lifecycle stage of the entity

Accepts one of the following:
"PRE_CREATED"
"AI_CREATING"
"AI_CREATION_FAILED"
"AI_NEEDS_REVIEW"
"DRAFT"
"READY_FOR_PROPOSAL"
"IMPLEMENTATION"
"ACTIVE"
"COMPLETED"
"ARCHIVED"
updated_at: string

Timestamp when the entity was last updated

formatdate-time

EntitiesValuation

Get the current valuation for an entity
client.entities.valuation.retrieve(stringid, RequestOptionsoptions?): Valuation { id, created_at, directly_held_asset_value, 6 more }
get/entities/{id}/valuation
Create a new valuation for an entity
client.entities.valuation.create(stringid, ValuationCreateParams { directly_held_assets, effective_date, description } body, RequestOptionsoptions?): Valuation { id, created_at, directly_held_asset_value, 6 more }
post/entities/{id}/valuation
ModelsExpand Collapse
Valuation { 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<DirectlyHeldAsset>

List of individual assets in this valuation

id: string

Asset ID

asset_class: AssetClass { 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?: string | null

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?: string | null

Free-form notes about this valuation

maxLength2048