# Individuals ## List all individuals (client profiles) `client.individuals.list(IndividualListParamsquery?, RequestOptionsoptions?): CursorPagination` **get** `/individuals` Retrieve a paginated list of client profiles/individuals using cursor-based pagination ### Parameters - `query: IndividualListParams` - `after?: string` Cursor for forward pagination. Returns items after this cursor. - `before?: string` Cursor for backward pagination. Returns items before this cursor. - `household_id?: string` Filter individuals by household ID - `is_primary?: boolean` Filter by primary client status - `limit?: number` Maximum number of items to return ### Returns - `Individual` - `id: string` Unique identifier with client_profile_ prefix - `created_at: string` Timestamp when the individual was created - `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 - `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) - `date_of_death?: string | null` Date of death if applicable (encrypted field) - `deleted_at?: string | null` Timestamp when the individual was soft deleted - `email?: string | null` Email address - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `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.) ### Example ```typescript import Luminary from 'withluminary'; const client = new Luminary(); // Automatically fetches more pages as needed. for await (const individual of client.individuals.list()) { console.log(individual.id); } ``` #### Response ```json { "data": [ { "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." } ], "page_info": { "has_next_page": true, "has_previous_page": false, "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9", "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9" }, "total_count": 100 } ``` ## Create a new individual (client profile) `client.individuals.create(IndividualCreateParamsbody, RequestOptionsoptions?): Individual` **post** `/individuals` Create a new client profile/individual with the provided data ### Parameters - `body: IndividualCreateParams` - `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 - `email?: string | null` Email address - `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 - `postal_code?: string | null` ZIP or postal code - `state?: string | null` State or province code (2 letter code) - `suffix?: string | null` Name suffix ### Returns - `Individual` - `id: string` Unique identifier with client_profile_ prefix - `created_at: string` Timestamp when the individual was created - `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 - `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) - `date_of_death?: string | null` Date of death if applicable (encrypted field) - `deleted_at?: string | null` Timestamp when the individual was soft deleted - `email?: string | null` Email address - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `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.) ### Example ```typescript 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); ``` #### Response ```json { "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." } ``` ## Delete an individual `client.individuals.delete(stringid, RequestOptionsoptions?): void` **delete** `/individuals/{id}` Soft delete a client profile (marks as deleted but preserves data) ### Parameters - `id: string` ### Example ```typescript import Luminary from 'withluminary'; const client = new Luminary(); await client.individuals.delete('id'); ``` ## Get an individual by ID `client.individuals.retrieve(stringid, RequestOptionsoptions?): Individual` **get** `/individuals/{id}` Retrieve detailed information about a specific client profile ### Parameters - `id: string` ### Returns - `Individual` - `id: string` Unique identifier with client_profile_ prefix - `created_at: string` Timestamp when the individual was created - `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 - `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) - `date_of_death?: string | null` Date of death if applicable (encrypted field) - `deleted_at?: string | null` Timestamp when the individual was soft deleted - `email?: string | null` Email address - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `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.) ### Example ```typescript import Luminary from 'withluminary'; const client = new Luminary(); const individual = await client.individuals.retrieve('id'); console.log(individual.id); ``` #### Response ```json { "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." } ``` ## Update an individual `client.individuals.update(stringid, IndividualUpdateParamsbody, RequestOptionsoptions?): Individual` **put** `/individuals/{id}` Update an existing client profile with new data ### Parameters - `id: string` - `body: IndividualUpdateParams` - `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 - `date_of_death?: string | null` Date of death if applicable - `email?: string | null` Email address - `first_name?: string` First name of the individual - `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 - `last_name?: string` Last name of the individual - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `postal_code?: string | null` ZIP or postal code - `state?: string | null` State or province code (2 letter code) - `suffix?: string | null` Name suffix ### Returns - `Individual` - `id: string` Unique identifier with client_profile_ prefix - `created_at: string` Timestamp when the individual was created - `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 - `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) - `date_of_death?: string | null` Date of death if applicable (encrypted field) - `deleted_at?: string | null` Timestamp when the individual was soft deleted - `email?: string | null` Email address - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `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.) ### Example ```typescript import Luminary from 'withluminary'; const client = new Luminary(); const individual = await client.individuals.update('id'); console.log(individual.id); ``` #### Response ```json { "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." } ``` ## Domain Types ### Individual - `Individual` - `id: string` Unique identifier with client_profile_ prefix - `created_at: string` Timestamp when the individual was created - `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 - `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) - `date_of_death?: string | null` Date of death if applicable (encrypted field) - `deleted_at?: string | null` Timestamp when the individual was soft deleted - `email?: string | null` Email address - `middle_name?: string | null` Middle name of the individual - `notes?: string | null` Notes about the client profile - `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.)