Skip to content
Luminary Luminary Luminary
Get started
API Reference
Individuals

Create a new individual (client profile)

client.individuals.create(IndividualCreateParams { first_name, household_id, last_name, 16 more } body, RequestOptionsoptions?): Individual { id, created_at, first_name, 21 more }
post/individuals

Create a new client profile/individual with the provided data

ParametersExpand Collapse
body: IndividualCreateParams { first_name, household_id, last_name, 16 more }
first_name: string

First name of the individual

household_id: string

Household ID this individual belongs to

last_name: string

Last name of the individual

address_line1?: string | null

Street address line 1

address_line2?: string | null

Street address line 2

city?: string | null

City

country?: string | null

Country

date_of_birth?: string | null

Date of birth

formatdate
email?: string | null

Email address

formatemail
is_beneficiary?: boolean

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

is_deceased?: boolean

Whether the individual is deceased

is_grantor?: boolean

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

is_primary?: boolean

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

is_trustee?: boolean

Whether this client profile should be an eligible trustee for entities

middle_name?: string | null

Middle name of the individual

notes?: string | null

Notes about the client profile

maxLength65536
postal_code?: string | null

ZIP or postal code

state?: string | null

State or province

suffix?: string | null

Name suffix

ReturnsExpand Collapse
Individual { id, created_at, first_name, 21 more }
id: string

Unique identifier with client_profile_ prefix

created_at: string

Timestamp when the individual was created

formatdate-time
first_name: string

First name of the individual

household_id: string

Household ID this individual belongs to

is_beneficiary: boolean

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

is_deceased: boolean

Whether this client profile is deceased

is_grantor: boolean

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

is_primary: boolean

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

is_trustee: boolean

Whether this client profile should be an eligible trustee for entities

last_name: string

Last name of the individual

updated_at: string

Timestamp when the individual was last updated

formatdate-time
address_line1?: string | null

Street address line 1 (from address edge)

address_line2?: string | null

Street address line 2 (from address edge)

city?: string | null

City (from address edge)

country?: string | null

Country (from address edge)

date_of_birth?: string | null

Date of birth (encrypted field)

formatdate
date_of_death?: string | null

Date of death if applicable (encrypted field)

formatdate
deleted_at?: string | null

Timestamp when the individual was soft deleted

formatdate-time
email?: string | null

Email address

formatemail
middle_name?: string | null

Middle name of the individual

notes?: string | null

Notes about the client profile

maxLength65536
postal_code?: string | null

ZIP or postal code (from address edge)

state?: string | null

State or province (from address edge)

suffix?: string | null

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

Create a new individual (client profile)
import Luminary from 'withluminary';

const client = new Luminary();

const individual = await client.individuals.create({
  first_name: 'John',
  household_id: 'household_01ARZ3NDEKTSV4RRFFQ69G5FAV',
  last_name: 'Smith',
});

console.log(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."
}