Skip to main content

CreateBrokerageFirmInput

An input type used when creating a brokerage firm and its first firm admin

input CreateBrokerageFirmInput {
  ein: String
  firmAdmin: CreateBrokerageFirmAdminInput!
  name: String!
  organizationUlids: [ID!]
}

Fields​

CreateBrokerageFirmInput.ein ● String scalar​

The Employer Identification Number of the brokerage firm. Accepted either punctuated (12-3456789) or bare (123456789); both resolve to the same firm. When supplied, it is validated and canonicalized, and the shared firm registry is deduplicated on it. An EIN starting with 18 is refused: the IRS does not issue that prefix, and it is reserved for placeholders.

Optional for a limited period. When it is omitted, the firm is matched on its normalized name: the name lowercased, punctuation removed, runs of whitespace collapsed to one space, and trimmed. Business suffixes such as Inc, LLC or Corp are kept, so Acme Benefits and Acme Benefits LLC are different names. Exactly one match is returned as ALREADY_EXISTED with matchedBy: NAME, and nothing is attached; no match creates the firm with a placeholder EIN; more than one match is refused with a BadRequestError asking for the EIN. An empty or blank value is refused, not treated as omitted.

CreateBrokerageFirmInput.firmAdmin ● CreateBrokerageFirmAdminInput! non-null input​

The first administrator of the firm. Ignored when a firm is returned as ALREADY_EXISTED, whether it was matched by EIN or by name — see CreateBrokerageFirmResult.status and matchedBy.

CreateBrokerageFirmInput.name ● String! non-null scalar​

The legal or display name of the brokerage firm

CreateBrokerageFirmInput.organizationUlids ● [ID!] list scalar​

Public ULIDs of the organizations this firm services, assigned as part of creating it. Matched exactly and case-sensitively; organization short codes are not accepted. Maximum 250 per request.

All-or-nothing here, unlike the standalone assign operation: if any identifier is malformed or is not one you control, the whole call is rejected and no firm is created. Results appear in CreateBrokerageFirmResult.organizationAssignments.

Member Of​

createBrokerageFirm mutation