Identity API

PersonSuffix

string

The person’s name suffix.

Allowed values:JRSRIIIIIIOBEMBEBSCJPGM

Example

PersonGender

string

The person’s gender.

Allowed values:MALEFEMALE

Example

PersonListItemV2

object

A single person row returned by GET /v2/persons. Carries the person’s core identity fields. Related resources such as addresses, phones, employments, and licenses are not included here — retrieve them via the single-resource and dedicated collection endpoints.

idstring(uuid)requiredread-only

The unique identifier of the person.

Example:550e8400-e29b-41d4-a716-446655440000

firstNamestring

The person’s first name.

Example:Jane

middleNamestring

The person’s middle name.

Example:Quincy

lastNamestring

The person’s last name.

Example:Smith

preferredFirstNamestring

The name the person prefers to be addressed by, when different from their legal first name.

Example:Janey

titlestring

The person’s honorific title.

Allowed values:DRMRMRSMSMISS

Example:MS

suffixstring

The person’s name suffix.

Allowed values:JRSRIIIIIIOBEMBEBSCJPGM

Example:JR

primaryEmailstring(email)

The person’s primary contact email address.

Example:jane.smith@example.com

secondaryEmailstring(email)

The person’s secondary contact email address.

Example:jane.alt@example.com

dateOfBirthstring(date)

The person’s date of birth (YYYY-MM-DD).

Example:1990-05-15

genderstring

The person’s gender.

Allowed values:MALEFEMALE

Example:FEMALE

citizenshipCountrystring

The person’s country of citizenship.

Example:US

residentStatestring

The person’s state of residence.

Example:CO

unitedStatesCitizenboolean

Whether the person is a United States citizen.

Example:true

unitedStatesWorkAuthorizedboolean

Whether the person is authorized to work in the United States.

Example:true

marriedboolean

Whether the person is married.

npnstring

National Producer Number. Null when the person’s NPN has not been verified.

Example:12345678

finraCrdNumberstring

The person’s FINRA Central Registration Depository (CRD) number.

Example:1234567

ssnLast4string

Last four digits of the Social Security Number. Null when no SSN is on record.

Example:6789

createdAtstring(date-time)requiredread-only

RFC3339 timestamp when the person record was created.

Example:2026-01-15T10:30:00Z

updatedAtstring(date-time)requiredread-only

RFC3339 timestamp of the most recent modification. Use this field with updated_since for delta sync.

Example:2026-06-01T14:22:00Z

Example

CreatePersonRequest

object

Fields for creating a new person. firstName, lastName, and primaryEmail are required. sendInvite defaults to false; set it to true to trigger an email invitation. Internal-only fields (customer ID, intake ID) are not accepted.

firstNamestringrequired

Example:Jane

lastNamestringrequired

Example:Smith

middleNamestring
preferredFirstNamestring

<= 100 characters

titlestring

The person’s honorific title.

Allowed values:DRMRMRSMSMISS

Example:MS

suffixstring

The person’s name suffix.

Allowed values:JRSRIIIIIIOBEMBEBSCJPGM

Example:JR

dateOfBirthstring(date)
genderstring

The person’s gender.

Allowed values:MALEFEMALE

Example:FEMALE

primaryEmailstring(email)required

Example:jane.smith@example.com

secondaryEmailstring(email)
citizenshipCountrystring
residentStatestring
unitedStatesCitizenboolean
unitedStatesWorkAuthorizedboolean
marriedboolean
npnstring

National Producer Number. Must start with a non-zero digit and contain only digits.

Match pattern:^[1-9][0-9]*$

<= 12 characters

finraCrdNumberstring

FINRA CRD number. Must contain only digits.

Match pattern:^[0-9]+$

<= 11 characters

ssnstring

Social Security Number. Must be exactly 9 digits.

Match pattern:^[0-9]*$

>= 9 characters<= 9 characters

sendInviteboolean

When true, sends an email invitation to the person. Defaults to false.

Default:false

Example

PersonV2

object

Customer-facing producer identity. SSN is masked — only the last four digits are present via ssnLast4. The full unmasked SSN is available only via GET /v2/persons/{personId}/ssn.

idstring(uuid)requiredread-only

The unique identifier of the person.

Example:550e8400-e29b-41d4-a716-446655440000

titlestring

The person’s honorific title.

Allowed values:DRMRMRSMSMISS

Example:MS

firstNamestring

The person’s first name.

Example:Jane

preferredFirstNamestring

The name the person prefers to be addressed by, when different from their legal first name.

Example:Janey

middleNamestring

The person’s middle name.

Example:Quincy

lastNamestring

The person’s last name.

Example:Smith

suffixstring

The person’s name suffix.

Allowed values:JRSRIIIIIIOBEMBEBSCJPGM

Example:JR

primaryEmailstring(email)

The person’s primary contact email address.

Example:jane.smith@example.com

secondaryEmailstring(email)

The person’s secondary contact email address.

Example:jane.alt@example.com

dateOfBirthstring(date)

The person’s date of birth (YYYY-MM-DD).

Example:1990-05-15

genderstring

The person’s gender.

Allowed values:MALEFEMALE

Example:FEMALE

citizenshipCountrystring

The person’s country of citizenship.

Example:US

residentStatestring

The person’s state of residence.

Example:CO

unitedStatesCitizenboolean

Whether the person is a United States citizen.

Example:true

unitedStatesWorkAuthorizedboolean

Whether the person is authorized to work in the United States.

Example:true

marriedboolean

Whether the person is married.

npnstring

National Producer Number.

Example:12345678

npnVerifiedbooleanrequiredread-only

Whether the person’s NPN has been verified against NIPR.

finraCrdNumberstring

The person’s FINRA Central Registration Depository (CRD) number.

Example:1234567

ssnLast4string

Last four digits of the Social Security Number. Full SSN available only via GET /v2/persons/{personId}/ssn.

Example:6789

createdAtstring(date-time)requiredread-only

RFC3339 timestamp when the person record was created.

Example:2026-01-15T10:30:00Z

updatedAtstring(date-time)requiredread-only

RFC3339 timestamp of the most recent modification.

Example:2026-06-01T14:22:00Z

Example