Skip to content
Luminary Luminary Luminary
Get started
API Reference

Entities

List all entities
entities.list(EntityListParams**kwargs) -> SyncCursorPagination[Entity]
get/entities
Delete an entity
entities.delete(strid)
delete/entities/{id}
Get an entity by ID
entities.retrieve(strid) -> Entity
get/entities/{id}
ModelsExpand Collapse
class Entity: …
id: str

Unique identifier with entity_ prefix

created_at: datetime

Timestamp when the entity was created

formatdate-time
display_name: str

Display name of the entity

household_id: str

Household ID this entity belongs to

in_estate_status: Literal["in_estate", "out_of_estate", "none"]

Whether the entity is in or out of the estate

Accepts one of the following:
"in_estate"
"out_of_estate"
"none"
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: Literal["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: datetime

Timestamp when the entity was last updated

formatdate-time
EntityKind = Literal["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"
class EntityList: …
data: List[Entity]
id: str

Unique identifier with entity_ prefix

created_at: datetime

Timestamp when the entity was created

formatdate-time
display_name: str

Display name of the entity

household_id: str

Household ID this entity belongs to

in_estate_status: Literal["in_estate", "out_of_estate", "none"]

Whether the entity is in or out of the estate

Accepts one of the following:
"in_estate"
"out_of_estate"
"none"
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: Literal["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: datetime

Timestamp when the entity was last updated

formatdate-time
page_info: PageInfo
has_next_page: bool

When paginating forwards, are there more items?

has_previous_page: bool

When paginating backwards, are there more items?

end_cursor: Optional[str]

Cursor pointing to the last item in the current page

start_cursor: Optional[str]

Cursor pointing to the first item in the current page

total_count: int

Total number of items matching the query (across all pages)

EntitiesValuation

Get the current valuation for an entity
entities.valuation.retrieve(strid) -> Valuation
get/entities/{id}/valuation
Create a new valuation for an entity
entities.valuation.create(strid, ValuationCreateParams**kwargs) -> Valuation
post/entities/{id}/valuation
ModelsExpand Collapse
class Valuation: …
id: str

Unique identifier with valuationv2_ prefix

created_at: datetime

Timestamp when the valuation was created

formatdate-time
directly_held_asset_value: float

Total value of all directly held assets in USD

formatdouble
directly_held_assets: List[DirectlyHeldAsset]

List of individual assets in this valuation

id: str

Asset ID

asset_class: DirectlyHeldAssetAssetClass
id: str

Asset class ID

display_name: str

Display name of the asset class

display_name: str

Display name of the asset

value: float

Value of this asset in USD

formatdouble
external_id: Optional[str]

External ID from the static asset (if available)

effective_date: date

The date this valuation is effective

formatdate
entity_id: str

Entity ID this valuation belongs to

total_value: float

Total value of all assets minus liabilities in USD

formatdouble
updated_at: datetime

Timestamp when the valuation was last updated

formatdate-time
description: Optional[str]

Free-form notes about this valuation

maxLength2048