Deel: Retrieve the KYB state of a legal entity — 200 response body — data edd status: AWAITING ANSWERS, ANSWERED questions item
Retrieve the KYB state of a legal entity: 200 response body, field data / edd / status: AWAITING_ANSWERS, ANSWERED / questions / item. 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 / edd / status: AWAITING ANSWERS, ANSWERED questions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Helper text for the question, when any. |
description (anyOf 2) | null | Alternative | Helper text for the question, when any. |
is_required | boolean | Required within parent | Whether the question must currently be answered. |
key | string | Required within parent | Key of the question within this EDD request, in form order. Send it as `question_key` when answering. |
options | JSON | Required within parent | |
options (anyOf 1) | array | Alternative | For `SINGLE_CHOICE` and `MULTIPLE_CHOICE` questions, the option titles to answer with. Null for every other type. |
options (anyOf 1)[] | string | Each item | |
options (anyOf 2) | null | Alternative | For `SINGLE_CHOICE` and `MULTIPLE_CHOICE` questions, the option titles to answer with. Null for every other type. |
options (anyOf 2)[] | string | Each item | |
repeat_group | JSON | Required within parent | Set when this question belongs to a repeatable group (e.g. “add another director”); null otherwise. |
repeat_group (anyOf 1) | Model | Alternative | Expand Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item repeat group index, max repeats, name |
repeat_group (anyOf 2) | null | Alternative | |
revealed_when | JSON | Required within parent | |
revealed_when (anyOf 1) | array | Alternative | Conditions under which this question applies, met if any one of them does. Null when the question always applies. Only answer it when a condition is met. |
revealed_when (anyOf 1)[] | Model | Each item | Expand Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item revealed when null item |
revealed_when (anyOf 2) | null | Alternative | Conditions under which this question applies, met if any one of them does. Null when the question always applies. Only answer it when a condition is met. |
revealed_when (anyOf 2)[] | Model | Each item | Expand Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item revealed when null item |
title | string | Required within parent | The question as the reviewer wrote it. |
type | Model | Required within parent | Expand Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item type What kind of answer the question takes. `COUNTRY` takes an ISO 3166-1 alpha-2 code (e.g. `US`), `CURRENCY` an ISO 4217 code (e.g. `USD`) and `STATE` a state name (e.g. `California`), each as a string, or a list of strings when the form allows several. `DOCUMENT_UPLOAD` questions are answered with a list of document handles from `POST /rest/legal-entities/{legal_entity_id}/kyb/edd/documents`. `UNSUPPORTED` questions cannot be answered over the API; when one of them is required, `is_answerable_over_api` is false. |
Referenced models: Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item revealed when null item, Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item repeat group index, max repeats, name, Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item type