FirmV2
objectCustomer-facing firm resource. The FEIN is always masked to ****; the full FEIN is available only via GET /v2/firms/{firmId}/fein (audited).
The unique identifier of the firm.
Example:550e8400-e29b-41d4-a716-446655440000
National Producer Number.
Example:1234567
Legal name of the firm.
Example:Acme Insurance LLC
Primary contact email address.
Example:contact@acme.com
Business entity type (SC, LLC, SP).
Example:LLC
FINRA CRD number (digits only, max 11 characters).
Example:12345
Masked Federal Employer Identification Number. Always returned as ****. The full FEIN is never exposed by this endpoint.
Example:****6789
Whether this is a test account.
ISO-8601 UTC timestamp when the firm was created.
Example:2024-01-15T10:30:00Z
ISO-8601 UTC timestamp of the last update.
Example:2024-06-01T14:22:00Z
FirmV2List
objectKeyset-paginated list of firms (F5 envelope).
Customer-facing firm resource. The FEIN is always masked to ****; the full FEIN is available only via GET /v2/firms/{firmId}/fein (audited).
Show Child Parameters
Page metadata for a token-based list response.
Show Child Parameters
UpdateFirmRequest
objectFields that may be updated on a firm. All fields are optional — omitted fields leave the stored value unchanged. The npn and fein fields are immutable and cannot be set via this endpoint.
Legal name of the firm.
Example:Acme Insurance LLC
Primary contact email address.
Example:contact@acme.com
Business entity type (SC, LLC, SP).
Example:LLC
FINRA CRD number (digits only, max 11 characters).
Match pattern:^[0-9]*$
<= 11 characters
Example:12345
FeinDto
objectCarries a firm’s full, unmasked Federal Employer Identification Number. Returned only by GET /v2/firms/{firmId}/fein; the FEIN is masked in all other responses.
The unique identifier of the firm.
Example:550e8400-e29b-41d4-a716-446655440000
The full, unmasked Federal Employer Identification Number (9 digits).
Example:123456789
PersonTitle
stringThe person’s honorific title.
Allowed values:DRMRMRSMSMISS