Skip to content

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

Retrieve the KYB state of a legal entity: 200 response body, field data. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: 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`, `proof_of_authority`, `persons`, `rejection`) 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. Identity documents are reported by presence only. 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. Identity documents are reported by presence only. 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
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 rejection rejected at, Retrieve the KYB state of a legal entity — 200 response body — data requirements null item

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.