Skip to content

Deel: Retrieve the KYB state of a legal entity

Deel legalEntities.getLegalEntityKybState: arguments, response, policy and SDK examples.

← Legal entities operations · Get started

Operation deel.legalentities_getlegalentitykybstate_v2026_10_01

Provider route: GET /legal-entities/{legal_entity_id}/kyb. 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"]["getLegalEntityKybState"]>[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.getLegalEntityKybState(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_kyb_state(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 parentFormat: uuid
headersobjectRequired within parentAdditional keys: not allowed
headers.X-BetastringRequired within parentDefault: true
One of: true

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve the KYB state of a legal entity — 200 response body

Referenced models: Retrieve the KYB state of a legal entity — 200 response body

12 more schemas are linked from the tables above, on the schema pages.

Retrieve the KYB state of a legal entity — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve the KYB state of a legal entity — 200 response body — data

Referenced models: Retrieve the KYB state of a legal entity — 200 response body — data

Retrieve the KYB state of a legal entity — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
approved_atJSONRequired within parent
approved_at (anyOf 1)stringAlternativeWhen the entity was approved; null otherwise.
Format: date-time
approved_at (anyOf 2)nullAlternativeWhen the entity was approved; null otherwise.
Format: date-time
documentsJSONRequired within parent
documents (anyOf 1)arrayAlternativePresence of every company-level document type. Null when `is_detail_available` is false.
documents (anyOf 1)[]ModelEach itemExpand Retrieve the KYB state of a legal entity — 200 response body — data documents null item
documents (anyOf 2)nullAlternativePresence of every company-level document type. Null when `is_detail_available` is false.
documents (anyOf 2)[]ModelEach itemExpand Retrieve the KYB state of a legal entity — 200 response body — data documents null item
eddJSONRequired within parentThe open enhanced due diligence (EDD) request while the entity is in EDD: Deel needs further answers from the client before it continues the review. Null otherwise, and null while the entity is in EDD when the questions could not be read (retry later).
edd (anyOf 1)ModelAlternativeExpand Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED
edd (anyOf 2)nullAlternative
is_action_requiredbooleanRequired within parentTrue while the entity is waiting on the client: `PENDING`, `DRAFT`, or `EDD` (enhanced due diligence — Ops needs something further from the client). False while Deel is reviewing or once the entity is approved, rejected or exempt.
is_detail_availablebooleanRequired within parentFalse when the verification service could not be read. Every detail block (`requirements`, `documents`, `persons`, `rejection`, `edd`) is then null. Retry later; the status fields are still authoritative.
legal_entity_idstringRequired within parentPublic id of the legal entity.
Format: uuid
personsJSONRequired within parent
persons (anyOf 1)arrayAlternativeDeclared persons of significant control: directors, controlling officers, owners and the submitter. Dates of birth, tax ids, addresses and identity documents are never returned; the person requirements in `requirements` show whether they were provided. Null when `is_detail_available` is false.
persons (anyOf 1)[]ModelEach itemExpand Retrieve the KYB state of a legal entity — 200 response body — data persons null item
persons (anyOf 2)nullAlternativeDeclared persons of significant control: directors, controlling officers, owners and the submitter. Dates of birth, tax ids, addresses and identity documents are never returned; the person requirements in `requirements` show whether they were provided. Null when `is_detail_available` is false.
persons (anyOf 2)[]ModelEach itemExpand Retrieve the KYB state of a legal entity — 200 response body — data persons null item
questionnaireJSONRequired within parentThe industry questionnaire that applies to the legal entity, answered together with the first KYB submission and listed as the `INDUSTRY_QUESTIONNAIRE` requirement. Null when none applies.
questionnaire (anyOf 1)ModelAlternativeExpand Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id
questionnaire (anyOf 2)nullAlternative
rejected_atJSONRequired within parent
rejected_at (anyOf 1)stringAlternativeWhen the entity was last rejected; null otherwise.
Format: date-time
rejected_at (anyOf 2)nullAlternativeWhen the entity was last rejected; null otherwise.
Format: date-time
rejectionJSONRequired within parentPresent only when the entity was rejected; null otherwise.
rejection (anyOf 1)ModelAlternativeExpand Retrieve the KYB state of a legal entity — 200 response body — data rejection rejected at
rejection (anyOf 2)nullAlternative
requirementsJSONRequired within parent
requirements (anyOf 1)arrayAlternativeEverything the verification service currently requires for this entity, with whether each item is already satisfied. Empty when verification is not required. Null when `is_detail_available` is false.
requirements (anyOf 1)[]ModelEach itemExpand Retrieve the KYB state of a legal entity — 200 response body — data requirements null item
requirements (anyOf 2)nullAlternativeEverything the verification service currently requires for this entity, with whether each item is already satisfied. Empty when verification is not required. Null when `is_detail_available` is false.
requirements (anyOf 2)[]ModelEach itemExpand Retrieve the KYB state of a legal entity — 200 response body — data requirements null item
statusstringRequired within parentThe mapped lifecycle status of the legal entity, the same vocabulary as `status` on `GET /rest/legal-entities/{legal_entity_id}`.
Known values: archived, active, draft, processing, processing_draft, pending_verification, awaiting_review, unknown
submitted_atJSONRequired within parent
submitted_at (anyOf 1)stringAlternativeWhen the verification record was created; null before the first submission.
Format: date-time
submitted_at (anyOf 2)nullAlternativeWhen the verification record was created; null before the first submission.
Format: date-time
verification_typeJSONRequired within parentDepth of verification the entity is subject to, when known.
verification_type (anyOf 1)stringAlternativeDepth of verification the entity is subject to, when known.
Known values: NONE, LIGHT, FULL
verification_type (anyOf 2)nullAlternative

Referenced models: Retrieve the KYB state of a legal entity — 200 response body — data documents null item, Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED, Retrieve the KYB state of a legal entity — 200 response body — data persons null item, Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id, Retrieve the KYB state of a legal entity — 200 response body — data rejection rejected at, Retrieve the KYB state of a legal entity — 200 response body — data requirements null item

Retrieve the KYB state of a legal entity — 200 response body — data documents null item
FieldTypePresenceDescription and constraints
$objectRoot
is_providedbooleanRequired within parentWhether a file for this document has been submitted. File contents and URLs are never returned.
is_requiredbooleanRequired within parentWhether the verification service currently requires this document.
meta_typeJSONRequired within parentKind of Proof of Authority document, when this entry's type is PROOF_OF_AUTHORITY. Null for every other document type.
meta_type (anyOf 1)stringAlternativeKind of Proof of Authority document, when this entry's type is PROOF_OF_AUTHORITY. Null for every other document type.
Known values: POWER_OF_ATTORNEY, RESOLUTION_OR_MINUTES, OTHER
meta_type (anyOf 2)nullAlternative
typestringRequired within parentCompany-level document type.
Known values: PROOF_OF_AUTHORITY, ARTICLES_OF_INCORPORATION, COMPANY_BANK_STATEMENT, LIST_OF_DIRECTORS, CERTIFICATE_OF_GOOD_STANDING, ULTIMATE_BENEFICIAL_OWNER_FORM
Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED
FieldTypePresenceDescription and constraints
$objectRootThe open enhanced due diligence (EDD) request while the entity is in EDD: Deel needs further answers from the client before it continues the review. Null otherwise, and null while the entity is in EDD when the questions could not be read (retry later).
idstringRequired within parentPublic id of the EDD request. Send it as `edd_request_id` when answering.
Format: uuid
is_answerable_over_apibooleanRequired within parentFalse when the form has a required unsupported question. Contact Deel support to clear such a request.
questionsarrayRequired within parentEvery question of the EDD form, in form order.
questions[]ModelEach itemExpand Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item
requested_atJSONRequired within parent
requested_at (anyOf 1)stringAlternativeWhen Deel requested the EDD.
Format: date-time
requested_at (anyOf 2)nullAlternativeWhen Deel requested the EDD.
Format: date-time
statusstringRequired within parent`AWAITING_ANSWERS` until the answers are sent; `ANSWERED` once they are, until the entity is back in review.
Known values: AWAITING_ANSWERS, ANSWERED

Referenced models: Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item

SDK function policy ID: deel.legalentities_getlegalentitykybstate_v2026_10_01. Catalog operation: legalentities_getlegalentitykybstate_v2026_10_01. 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-10-01"}

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.