Deel: Retrieve a legal entity
Deel legalEntities.getLegalEntity: arguments, response, policy and SDK examples.
← Legal entities operations · Get started
Operation deel.legalentities_getlegalentity_v2026_09_09
Provider route: GET /legal-entities/{legal_entity_id}. 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"]["getLegalEntity"]>[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.getLegalEntity(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.get_legal_entity(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.legal_entity_id | string | Required within parent |
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 Retrieve a legal entity — 200 response body |
Referenced models: Retrieve a legal entity — 200 response body
Schemas
Section titled “Schemas”Retrieve a legal entity — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Retrieve a legal entity — 200 response body — data |
Referenced models: Retrieve a legal entity — 200 response body — data
Retrieve a legal entity — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (anyOf 1) | Model | Alternative | Expand Retrieve a legal entity — 200 response body — data address city, country, state, street, zip |
address (anyOf 2) | null | Alternative | |
archived_at | JSON | Optional | |
archived_at (anyOf 1) | string | Alternative | The timestamp when the legal entity was archived, if any. Format: date-time |
archived_at (anyOf 2) | null | Alternative | The timestamp when the legal entity was archived, if any. Format: date-time |
cdd_status | JSON | Optional | The raw CDD verification status. When verification has not started it is coalesced to a tier-dependent initial value: PENDING when CDD is required, NOT_REQUIRED for Tier-0/SaaS entities. |
cdd_status (anyOf 1) | string | Alternative | The raw CDD verification status. When verification has not started it is coalesced to a tier-dependent initial value: PENDING when CDD is required, NOT_REQUIRED for Tier-0/SaaS entities. Known values: NOT_REQUIRED, PENDING, PENDING_ASYNC_TASKS, DRAFT, SUBMITTED, APPROVED, REJECTED, EDD |
cdd_status (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | The country of the legal entity (ISO 2-letter code). |
country (anyOf 2) | null | Alternative | The country of the legal entity (ISO 2-letter code). |
created_at | string | Optional | The timestamp when the legal entity was created. Format: date-time |
entity_type | JSON | Optional | |
entity_type (anyOf 1) | string | Alternative | The entity subtype. |
entity_type (anyOf 2) | null | Alternative | The entity subtype. |
id | string | Optional | The unique identifier of the legal entity. |
incorporation_date | JSON | Optional | |
incorporation_date (anyOf 1) | string | Alternative | The incorporation date of the legal entity. Format: date |
incorporation_date (anyOf 2) | null | Alternative | The incorporation date of the legal entity. Format: date |
industry_name | JSON | Optional | |
industry_name (anyOf 1) | string | Alternative | The industry name of the legal entity. |
industry_name (anyOf 2) | null | Alternative | The industry name of the legal entity. |
legal_name | JSON | Optional | |
legal_name (anyOf 1) | string | Alternative | The registered legal name of the entity. |
legal_name (anyOf 2) | null | Alternative | The registered legal name of the entity. |
legal_type | JSON | Optional | The legal type of the entity. |
legal_type (anyOf 1) | string | Alternative | The legal type of the entity. Known values: individual, company, light |
legal_type (anyOf 2) | null | Alternative | |
name | string | Optional | The name of the legal entity. |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | The phone number of the legal entity. |
phone (anyOf 2) | null | Alternative | The phone number of the legal entity. |
registration_number | JSON | Optional | |
registration_number (anyOf 1) | string | Alternative | The registration number of the legal entity. |
registration_number (anyOf 2) | null | Alternative | The registration number of the legal entity. |
status | string | Optional | The mapped legal entity lifecycle status. Known values: archived, active, draft, processing, processing_draft, pending_verification, awaiting_review, unknown |
updated_at | string | Optional | The timestamp when the legal entity was last updated. Format: date-time |
vat_id | JSON | Optional | |
vat_id (anyOf 1) | string | Alternative | The VAT identifier of the legal entity. |
vat_id (anyOf 2) | null | Alternative | The VAT identifier of the legal entity. |
Referenced models: Retrieve a legal entity — 200 response body — data address city, country, state, street, zip
Retrieve a legal entity — 200 response body — data address city, country, state, street, zip
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | The city. |
city (anyOf 2) | null | Alternative | The city. |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | The ISO 2-letter country code. |
country (anyOf 2) | null | Alternative | The ISO 2-letter country code. |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | The state. |
state (anyOf 2) | null | Alternative | The state. |
street | JSON | Optional | |
street (anyOf 1) | string | Alternative | The street address. |
street (anyOf 2) | null | Alternative | The street address. |
zip | JSON | Optional | |
zip (anyOf 1) | string | Alternative | The zip code. |
zip (anyOf 2) | null | Alternative | The zip code. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.legalentities_getlegalentity_v2026_09_09. Catalog operation: legalentities_getlegalentity_v2026_09_09. 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:read"]
Pinned headers: {"X-Version": "2026-09-09"}