Create a new individual (client profile)

client.Individuals.New(ctx, body) (*Individual, error)

post/individuals

Create a new client profile/individual with the provided data

ParametersExpand Collapse

body IndividualNewParams

FirstName param.Field[string]

First name of the individual

minLength1

HouseholdID param.Field[string]

Household ID this individual belongs to

LastName param.Field[string]

Last name of the individual

minLength1

AddressLine1 param.Field[string]optional

Street address line 1

minLength1

AddressLine2 param.Field[string]optional

Street address line 2

minLength1

City param.Field[string]optional

City

minLength1

Country param.Field[string]optional

Country

minLength1

DateOfBirth param.Field[Time]optional

Date of birth

formatdate

Email param.Field[string]optional

Email address

formatemail

IsBeneficiary param.Field[bool]optional

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

IsDeceased param.Field[bool]optional

Whether the individual is deceased

IsGrantor param.Field[bool]optional

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

IsPrimary param.Field[bool]optional

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

IsTrustee param.Field[bool]optional

Whether this client profile should be an eligible trustee for entities

MiddleName param.Field[string]optional

Middle name of the individual

minLength1

Notes param.Field[string]optional

Notes about the client profile

maxLength65536

PostalCode param.Field[string]optional

ZIP or postal code

minLength1

State param.Field[string]optional

State or province code (2 letter code)

maxLength2

minLength2

Suffix param.Field[string]optional

Name suffix

minLength1

ReturnsExpand Collapse

type Individual struct{…}

ID string

Unique identifier with client_profile_ prefix

CreatedAt Time

Timestamp when the individual was created

formatdate-time

FirstName string

First name of the individual

HouseholdID string

Household ID this individual belongs to

IsBeneficiary bool

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

IsDeceased bool

Whether this client profile is deceased

IsGrantor bool

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

IsPrimary bool

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

IsTrustee bool

Whether this client profile should be an eligible trustee for entities

LastName string

Last name of the individual

UpdatedAt Time

Timestamp when the individual was last updated

formatdate-time

AddressLine1 stringoptional

Street address line 1 (from address edge)

AddressLine2 stringoptional

Street address line 2 (from address edge)

City stringoptional

City (from address edge)

Country stringoptional

Country (from address edge)

DateOfBirth Timeoptional

Date of birth (encrypted field)

formatdate

DateOfDeath Timeoptional

Date of death if applicable (encrypted field)

formatdate

DeletedAt Timeoptional

Timestamp when the individual was soft deleted

formatdate-time

Email stringoptional

Email address

formatemail

MiddleName stringoptional

Middle name of the individual

Notes stringoptional

Notes about the client profile

maxLength65536

PostalCode stringoptional

ZIP or postal code (from address edge)

State stringoptional

State or province (from address edge)

Suffix stringoptional

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

Create a new individual (client profile)

package main

import (
  "context"
  "fmt"

  "github.com/withluminary/go-sdk"
  "github.com/withluminary/go-sdk/option"
)

func main() {
  client := withluminary.NewClient(
    option.WithClientID("My Client ID"),
    option.WithClientSecret("My Client Secret"),
  )
  individual, err := client.Individuals.New(context.TODO(), withluminary.IndividualNewParams{
    FirstName: "John",
    HouseholdID: "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    LastName: "Smith",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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."
}