Business Entity Management - SANNOS Partner API

Business entities represent legal/organizational units within a client company. A default one is created during onboarding.

Legacy (v1): use Organization Units instead. Every route on this page is deprecated and has no /v2 twin: POST /v1/business-entities, GET /v1/business-entities, GET /v1/business-entities/{id} and PATCH /v1/business-entities/{id}. A business entity is an organization unit of the built-in business_entity type: list them with GET /v2/organization-units?type=business_entity and create one with POST /v2/organization-units and "type": "business_entity". See Organization Units and Migrating to v2.

This page describes the /v1/business-entities routes, which work only with organization units of the business_entity type. Endpoints (all Company Key):

POST /v1/business-entities — create a new business entity
GET /v1/business-entities — list business entities for the company
GET /v1/business-entities/{id} — get specific business entity
PATCH /v1/business-entities/{id} — update business entity metadata

Create entity:
  Partner ──POST /v1/business-entities──> API
         <── 200 OK { businessEntityId, name, status, ... }

List entities:
  Partner ──GET /v1/business-entities──> API
         <── 200 OK [ { businessEntityId, name, ... } ]

Update entity:
  Partner ──PATCH /v1/business-entities/{id}──> API
         <── 200 OK { updated entity }

Key behaviors:

Business entities created via Partner API are auto-approved (unlike self-service where admin approval may be required)
Each business entity can have its own document submissions and compliance reviews
To create a new compliance review for a business entity, pass its businessEntityId as organizationUnitId to POST /v2/documents/submit
Scoped to the authenticated company — cannot access other companies’ entities