Add a Licensed Entity
Create a branch under your top company
What you cannot set, and why
parentId
parentId
Product features and plan
Product features and plan
Onboarding and customer flags
Onboarding and customer flags
Notes
branchNamedefaults tolegalNamewhen omitted. It cannot be stored empty.- NPN is not unique across your group: branches may legitimately share one. An NPN already held outside your organization is rejected with 409.
isNpnRequired: truewithout annpnis a 400. An entity with no NPN gets no compliance data subscription, so no licences or appointments will ever appear for it.
Idempotency-Key header. See Idempotency.Headers
UUID to ensure idempotent request processing
"550e8400-e29b-41d4-a716-446655440000"
Alternative UUID header for idempotent request processing
"550e8400-e29b-41d4-a716-446655440000"
Body
Registered legal name of the new entity.
"Example Insurance Services of Pennsylvania, LLC"
Name of this specific branch location. Defaults to the legal name when omitted β the field is required in storage and rejects an empty string, so there is no way to have no branch name.
"Philadelphia Branch"
National Producer Number. Branches within one group may share an NPN, so this is not unique. An NPN already held outside your organization is rejected with 409.
"1234567"
Whether this entity is required to hold an NPN. When true, npn must be supplied. An entity with no NPN gets no NIPR subscription and therefore no licence or appointment data.
true
Employer Identification Number
"12-3456789"
Doing-business-as name
"Example Branch"
States and territories of incorporation
AL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, GU, PR, VI, DC Website URL
"https://example-insurance.com"
Primary phone number
"+12155550100"