Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.legal_entity_idstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a legal entity — 200 response body

Referenced models: Retrieve a legal entity — 200 response body

Retrieve a legal entity — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (anyOf 1)ModelAlternativeExpand Retrieve a legal entity — 200 response body — data address city, country, state, street, zip
address (anyOf 2)nullAlternative
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeThe timestamp when the legal entity was archived, if any.
Format: date-time
archived_at (anyOf 2)nullAlternativeThe timestamp when the legal entity was archived, if any.
Format: date-time
cdd_statusJSONOptionalThe 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)stringAlternativeThe 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)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternativeThe country of the legal entity (ISO 2-letter code).
country (anyOf 2)nullAlternativeThe country of the legal entity (ISO 2-letter code).
created_atstringOptionalThe timestamp when the legal entity was created.
Format: date-time
entity_typeJSONOptional
entity_type (anyOf 1)stringAlternativeThe entity subtype.
entity_type (anyOf 2)nullAlternativeThe entity subtype.
idstringOptionalThe unique identifier of the legal entity.
incorporation_dateJSONOptional
incorporation_date (anyOf 1)stringAlternativeThe incorporation date of the legal entity.
Format: date
incorporation_date (anyOf 2)nullAlternativeThe incorporation date of the legal entity.
Format: date
industry_nameJSONOptional
industry_name (anyOf 1)stringAlternativeThe industry name of the legal entity.
industry_name (anyOf 2)nullAlternativeThe industry name of the legal entity.
legal_nameJSONOptional
legal_name (anyOf 1)stringAlternativeThe registered legal name of the entity.
legal_name (anyOf 2)nullAlternativeThe registered legal name of the entity.
legal_typeJSONOptionalThe legal type of the entity.
legal_type (anyOf 1)stringAlternativeThe legal type of the entity.
Known values: individual, company, light
legal_type (anyOf 2)nullAlternative
namestringOptionalThe name of the legal entity.
phoneJSONOptional
phone (anyOf 1)stringAlternativeThe phone number of the legal entity.
phone (anyOf 2)nullAlternativeThe phone number of the legal entity.
registration_numberJSONOptional
registration_number (anyOf 1)stringAlternativeThe registration number of the legal entity.
registration_number (anyOf 2)nullAlternativeThe registration number of the legal entity.
statusstringOptionalThe mapped legal entity lifecycle status.
Known values: archived, active, draft, processing, processing_draft, pending_verification, awaiting_review, unknown
updated_atstringOptionalThe timestamp when the legal entity was last updated.
Format: date-time
vat_idJSONOptional
vat_id (anyOf 1)stringAlternativeThe VAT identifier of the legal entity.
vat_id (anyOf 2)nullAlternativeThe 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
FieldTypePresenceDescription and constraints
$objectRoot
cityJSONOptional
city (anyOf 1)stringAlternativeThe city.
city (anyOf 2)nullAlternativeThe city.
countryJSONOptional
country (anyOf 1)stringAlternativeThe ISO 2-letter country code.
country (anyOf 2)nullAlternativeThe ISO 2-letter country code.
stateJSONOptional
state (anyOf 1)stringAlternativeThe state.
state (anyOf 2)nullAlternativeThe state.
streetJSONOptional
street (anyOf 1)stringAlternativeThe street address.
street (anyOf 2)nullAlternativeThe street address.
zipJSONOptional
zip (anyOf 1)stringAlternativeThe zip code.
zip (anyOf 2)nullAlternativeThe zip code.

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.