Search
K
Identity API

FirmV2List

object

Keyset-paginated list of firms (F5 envelope).

itemsarray[object]required

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
pageobjectrequired

Page metadata for a token-based list response.

Show Child Parameters
Example

UpdateFirmRequest

object

Fields 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.

namestring

Legal name of the firm.

Example:Acme Insurance LLC

emailstring(email)

Primary contact email address.

Example:contact@acme.com

typestring

Business entity type (SC, LLC, SP).

Example:LLC

finraCrdNumberstring

FINRA CRD number (digits only, max 11 characters).

Match pattern:^[0-9]*$

<= 11 characters

Example:12345

Example

FeinDto

object

Carries 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.

firmIdstring(uuid)required

The unique identifier of the firm.

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

feinstringrequired

The full, unmasked Federal Employer Identification Number (9 digits).

Example:123456789

Example

PersonTitle

string

The person’s honorific title.

Allowed values:DRMRMRSMSMISS

Example

PersonSuffix

string

The person’s name suffix.

Allowed values:JRSRIIIIIIOBEMBEBSCJPGM

Example