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
PersonFirmV2
objectAn association between a person and a firm.
The unique identifier of the associated person.
Example:550e8400-e29b-41d4-a716-446655440000
The unique identifier of the associated firm.
Example:660e8400-e29b-41d4-a716-446655440111
The person’s role in the firm.
Allowed values:PRINCIPALAGENT_FIRM_MANAGERAGENT
Example:PRINCIPAL
AddressType
stringType of address
Allowed values:MAILINGBUSINESSPHYSICAL