Create a new individual (client profile)

individuals.create() -> Individual

post/individuals

Create a new client profile/individual with the provided data

ParametersExpand Collapse

first_name: str

First name of the individual

household_id: str

Household ID this individual belongs to

last_name: str

Last name of the individual

address_line1: Optional[str]

Street address line 1

address_line2: Optional[str]

Street address line 2

city: Optional[str]

City

country: Optional[str]

Country

date_of_birth: Optional[Union[null, null, null]]

Date of birth

formatdate

email: Optional[str]

Email address

formatemail

is_beneficiary: Optional[bool]

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

is_deceased: Optional[bool]

Whether the individual is deceased

is_grantor: Optional[bool]

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

is_primary: Optional[bool]

Whether this is a primary client of the household (at most 2 per household)

is_trustee: Optional[bool]

Whether this client profile should be an eligible trustee for entities

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

state: Optional[str]

State or province

suffix: Optional[str]

Name suffix

ReturnsExpand 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.)

Create a new individual (client profile)

from withluminary import Luminary

client = Luminary()
individual = client.individuals.create(
    first_name="John",
    household_id="household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    last_name="Smith",
)
print(individual.id)

{
  "id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "created_at": "2024-01-15T09:30:00Z",
  "first_name": "John",
  "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "is_beneficiary": true,
  "is_deceased": true,
  "is_grantor": true,
  "is_primary": true,
  "is_trustee": true,
  "last_name": "Smith",
  "updated_at": "2024-01-20T14:45:00Z",
  "address_line1": "123 Main St",
  "address_line2": "Apt 4B",
  "city": "San Francisco",
  "country": "USA",
  "date_of_birth": "1980-05-15",
  "date_of_death": "2019-12-27",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "email": "john.smith@example.com",
  "middle_name": "Michael",
  "notes": "notes",
  "postal_code": "94102",
  "state": "CA",
  "suffix": "Jr."
}

Returns Examples

{
  "id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "created_at": "2024-01-15T09:30:00Z",
  "first_name": "John",
  "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "is_beneficiary": true,
  "is_deceased": true,
  "is_grantor": true,
  "is_primary": true,
  "is_trustee": true,
  "last_name": "Smith",
  "updated_at": "2024-01-20T14:45:00Z",
  "address_line1": "123 Main St",
  "address_line2": "Apt 4B",
  "city": "San Francisco",
  "country": "USA",
  "date_of_birth": "1980-05-15",
  "date_of_death": "2019-12-27",
  "deleted_at": "2019-12-27T18:11:19.117Z",
  "email": "john.smith@example.com",
  "middle_name": "Michael",
  "notes": "notes",
  "postal_code": "94102",
  "state": "CA",
  "suffix": "Jr."
}