Deel: Create a new legal entity
Deel legalEntities.createLegalEntity: arguments, response, policy and SDK examples.
← Legal entities operations · Get started
Operation deel.legalentities_createlegalentity
Provider route: POST /legal-entities. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["legalEntities"]["createLegalEntity"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.legalEntities.createLegalEntity(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.legal_entities.create_legal_entity(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | object | Optional | |
body.data | Model | Optional | Expand Create a new legal entity — request body — body data |
Referenced models: Create a new legal entity — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Create a new legal entity — 200 response body |
Referenced models: Create a new legal entity — 200 response body
Schemas
Section titled “Schemas”Create a new legal entity — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Required within parent | Expand Create a new legal entity — request body — body data address The physical address of the entity. |
company_identifiers | Model | Required within parent | Expand Create a new legal entity — request body — body data company identifiers |
entity_type | string | Required within parent | Type of the entity. |
name | string | Required within parent | The legal name of the entity. |
phone | string | Required within parent | Contact phone number for the entity. |
sic_number | string | Required within parent | The SIC number for the entity. |
Referenced models: Create a new legal entity — request body — body data address, Create a new legal entity — request body — body data company identifiers
Create a new legal entity — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Create a new legal entity — 200 response body — data |
Referenced models: Create a new legal entity — 200 response body — data
Create a new legal entity — request body — body data address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The physical address of the entity. |
city | string | Required within parent | City name. |
country | string | Required within parent | Country code. |
state | string | Optional | State |
street | string | Required within parent | Street address. |
zip | string | Required within parent | Zip code. |
Create a new legal entity — request body — body data company identifiers
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
registration_number | string | Required within parent | Registration number of the entity. |
tax_number | string | Required within parent | Tax number of the entity. |
Create a new legal entity — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Optional | Expand Create a new legal entity — 200 response body — data address The entity's address. |
created_at | string | Optional | Timestamp when the entity was created. Format: date-time |
entity_type | string | Optional | Type of the entity. |
id | string | Optional | The unique identifier for the legal entity. |
name | string | Optional | The name of the entity. |
phone | string | Optional | The contact number of the entity. |
sic_number | string | Optional | The SIC number of the entity. |
updated_at | string | Optional | Timestamp when the entity was last updated. Format: date-time |
Referenced models: Create a new legal entity — 200 response body — data address
Create a new legal entity — 200 response body — data address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The entity's address. |
city | string | Optional | |
country | string | Optional | |
state | string | Optional | |
street | string | Optional | |
zip | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.legalentities_createlegalentity. Catalog operation: legalentities_createlegalentity. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["legal-entity:write", "legal-entity:read"]
Pinned headers: {"X-Version": "2026-01-01"}