Skip to content
Luminary Luminary Luminary
Get started
API Reference

Individuals

List all individuals (client profiles)
individuals.list(IndividualListParams**kwargs) -> IndividualList
get/individuals
Create a new individual (client profile)
individuals.create(IndividualCreateParams**kwargs) -> Individual
post/individuals
Delete an individual
individuals.delete(strid)
delete/individuals/{id}
Get an individual by ID
individuals.retrieve(strid) -> Individual
get/individuals/{id}
Update an individual
individuals.update(strid, IndividualUpdateParams**kwargs) -> Individual
put/individuals/{id}
ModelsExpand Collapse
class Individual: …
id: str

Unique identifier with client_profile_ prefix

created_at: datetime

Timestamp when the individual was created

formatdate-time
first_name: str

First name of the individual

household_id: str

Household ID this individual belongs to

is_beneficiary: bool

Whether this client profile should be an eligible beneficiary for entities and gifts

is_deceased: bool

Whether this client profile is deceased

is_grantor: bool

Whether this client profile should be an eligible grantor/owner/other principal for entities

is_primary: bool

Whether this is one of the (at most) two primary clients on this household

is_trustee: bool

Whether this client profile should be an eligible trustee for entities

last_name: str

Last name of the individual

updated_at: datetime

Timestamp when the individual was last updated

formatdate-time
address_line1: Optional[str]

Street address line 1 (from address edge)

address_line2: Optional[str]

Street address line 2 (from address edge)

city: Optional[str]

City (from address edge)

country: Optional[str]

Country (from address edge)

date_of_birth: Optional[date]

Date of birth (encrypted field)

formatdate
date_of_death: Optional[date]

Date of death if applicable (encrypted field)

formatdate
deleted_at: Optional[datetime]

Timestamp when the individual was soft deleted

formatdate-time
email: Optional[str]

Email address

formatemail
middle_name: Optional[str]

Middle name of the individual

notes: Optional[str]

Notes about the client profile

maxLength65536
postal_code: Optional[str]

ZIP or postal code (from address edge)

state: Optional[str]

State or province (from address edge)

suffix: Optional[str]

Name suffix (Jr., Sr., III, etc.)