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
AddressV2
objectAddress identifier.
Example:550e8400-e29b-41d4-a716-446655440000
Type of address
Allowed values:MAILINGBUSINESSPHYSICAL
First line of the street address.
Example:123 Main St
Second line of the street address (suite, unit, etc.).
Example:Apt 4B
City.
Example:Denver
Two-letter US state code.
>= 2 characters<= 2 characters
Example:CO
ZIP code in 5-digit or ZIP+4 format.
Match pattern:^\d{5}(-\d{4})?$
Example:80202
County name.
Example:Denver
Country code (ISO alpha-2).
>= 2 characters<= 2 characters
Example:US
Date the person moved to this address (YYYY-MM-DD).
Example:2020-01-15
Whether this is the person’s preferred address.
Example:true
RFC3339 UTC timestamp when the address was created.
Example:2024-01-15T10:30:00Z
RFC3339 UTC timestamp when the address was last updated.
Example:2024-01-15T14:45:00Z