CreatePersonRequest
objectFields 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.
Example:Jane
Example:Smith
<= 100 characters
The person’s honorific title.
Allowed values:DRMRMRSMSMISS
Example:MS
The person’s name suffix.
Allowed values:JRSRIIIIIIOBEMBEBSCJPGM
Example:JR
The person’s gender.
Allowed values:MALEFEMALE
Example:FEMALE
Example:jane.smith@example.com
National Producer Number. Must start with a non-zero digit and contain only digits.
Match pattern:^[1-9][0-9]*$
<= 12 characters
FINRA CRD number. Must contain only digits.
Match pattern:^[0-9]+$
<= 11 characters
Social Security Number. Must be exactly 9 digits.
Match pattern:^[0-9]*$
>= 9 characters<= 9 characters
When true, sends an email invitation to the person. Defaults to false.
Default:false
PersonV2
objectCustomer-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.
The unique identifier of the person.
Example:550e8400-e29b-41d4-a716-446655440000
The person’s honorific title.
Allowed values:DRMRMRSMSMISS
Example:MS
The person’s first name.
Example:Jane
The name the person prefers to be addressed by, when different from their legal first name.
Example:Janey
The person’s middle name.
Example:Quincy
The person’s last name.
Example:Smith
The person’s name suffix.
Allowed values:JRSRIIIIIIOBEMBEBSCJPGM
Example:JR
The person’s primary contact email address.
Example:jane.smith@example.com
The person’s secondary contact email address.
Example:jane.alt@example.com
The person’s date of birth (YYYY-MM-DD).
Example:1990-05-15
The person’s gender.
Allowed values:MALEFEMALE
Example:FEMALE
The person’s country of citizenship.
Example:US
The person’s state of residence.
Example:CO
Whether the person is a United States citizen.
Example:true
Whether the person is authorized to work in the United States.
Example:true
Whether the person is married.
National Producer Number.
Example:12345678
Whether the person’s NPN has been verified against NIPR.
The person’s FINRA Central Registration Depository (CRD) number.
Example:1234567
Last four digits of the Social Security Number. Full SSN available only via GET /v2/persons/{personId}/ssn.
Example:6789
RFC3339 timestamp when the person record was created.
Example:2026-01-15T10:30:00Z
RFC3339 timestamp of the most recent modification.
Example:2026-06-01T14:22:00Z
UpdatePersonRequest
objectFields to apply to a person. Only non-null fields are applied — omitted or null fields leave the stored value untouched (partial update). firstName and lastName are required.
Example:Grace
Example:Hopper
<= 100 characters
The person’s honorific title.
Allowed values:DRMRMRSMSMISS
Example:MS
The person’s name suffix.
Allowed values:JRSRIIIIIIOBEMBEBSCJPGM
Example:JR
The person’s gender.
Allowed values:MALEFEMALE
Example:FEMALE
National Producer Number. Must start with a non-zero digit and contain only digits.
Match pattern:^[1-9][0-9]*$
<= 12 characters
FINRA CRD number. Must contain only digits.
Match pattern:^[0-9]+$
<= 11 characters
Social Security Number. Must be exactly 9 digits.
Match pattern:^[0-9]*$
>= 9 characters<= 9 characters
SsnResponse
objectCarries a person’s full, unmasked Social Security Number. Returned only by GET /v2/persons/{personId}/ssn; the SSN is masked in all other responses.
The unique identifier of the person.
Example:550e8400-e29b-41d4-a716-446655440000
The full, unmasked Social Security Number (9 digits).
Example:123456789
AssociateFirmRequestV2
objectIdentifies the existing firm to associate with the person, and optionally the person’s role in it.
The unique identifier of the firm to associate.
Example:550e8400-e29b-41d4-a716-446655440000
The person’s role in the firm. Defaults to PRINCIPAL when omitted.
Allowed values:PRINCIPALAGENT_FIRM_MANAGERAGENT
Default:PRINCIPAL
Example:PRINCIPAL