Deel: Legal entities schemas
63 Deel schemas with complete fields and constraints.
← Legal entities operations · All schemas
Create a new legal entity — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Create a new legal entity — 200 response body — data |
Referenced models: Create a new legal entity — 200 response body — data
Create a new legal entity — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Optional | Expand Create a new legal entity — 200 response body — data address The entity's address. |
created_at | string | Optional | Timestamp when the entity was created. Format: date-time |
entity_type | string | Optional | Type of the entity. |
id | string | Optional | The unique identifier for the legal entity. |
name | string | Optional | The name of the entity. |
phone | string | Optional | The contact number of the entity. |
sic_number | string | Optional | The SIC number of the entity. |
updated_at | string | Optional | Timestamp when the entity was last updated. Format: date-time |
Referenced models: Create a new legal entity — 200 response body — data address
Create a new legal entity — 200 response body — data address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The entity's address. |
city | string | Optional | |
country | string | Optional | |
state | string | Optional | |
street | string | Optional | |
zip | string | Optional |
Create a new legal entity — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Required within parent | Expand Create a new legal entity — request body — body data address The physical address of the entity. |
company_identifiers | Model | Required within parent | Expand Create a new legal entity — request body — body data company identifiers |
entity_type | string | Required within parent | Type of the entity. |
name | string | Required within parent | The legal name of the entity. |
phone | string | Required within parent | Contact phone number for the entity. |
sic_number | string | Required within parent | The SIC number for the entity. |
Referenced models: Create a new legal entity — request body — body data address, Create a new legal entity — request body — body data company identifiers
Create a new legal entity — request body — body data address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The physical address of the entity. |
city | string | Required within parent | City name. |
country | string | Required within parent | Country code. |
state | string | Optional | State |
street | string | Required within parent | Street address. |
zip | string | Required within parent | Zip code. |
Create a new legal entity — request body — body data company identifiers
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
registration_number | string | Required within parent | Registration number of the entity. |
tax_number | string | Required within parent | Tax number of the entity. |
Delete a legal entity — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
archived_at | string | Optional | The timestamp when the legal entity was archived. Format: date-time |
Edit a legal entity — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Edit a legal entity — 200 response body — data |
Referenced models: Edit a legal entity — 200 response body — data
Edit a legal entity — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Optional | Expand Edit a legal entity — 200 response body — data address |
company_identifiers | Model | Optional | Expand Edit a legal entity — 200 response body — data company identifiers |
entity_type | string | Optional | The type of the legal entity. |
id | string | Optional | The unique identifier of the legal entity. |
industry_name | string | Optional | The industry name of the legal entity. |
name | string | Optional | The name of the legal entity. |
phone | string | Optional | The phone number of the legal entity. |
sic_number | string | Optional | The SIC number of the legal entity. |
Referenced models: Edit a legal entity — 200 response body — data address, Edit a legal entity — 200 response body — data company identifiers
Edit a legal entity — 200 response body — data address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | string | Optional | The city. |
country | string | Optional | The ISO 2-letter country code. |
state | string | Optional | The state. |
street | string | Optional | The street address. |
Edit a legal entity — 200 response body — data company identifiers
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
registration_number | string | Optional | The registration number of the legal entity. |
tax_number | string | Optional | The tax identification number of the legal entity. |
Edit a legal entity — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Optional | Expand Edit a legal entity — request body — body data address |
company_identifiers | Model | Optional | Expand Edit a legal entity — request body — body data company identifiers Identifiers associated with the legal entity. |
deel_industry_subcategory_id | string | Optional | Reference to the Deel Industry Code (NAICS). |
entity_type | string | Optional | The type of the legal entity. |
industry_name | string | Optional | The industry name of the legal entity. |
name | string | Optional | The name of the legal entity. |
phone | string | Optional | The phone number of the legal entity. |
sic_number | string | Optional | The SIC number of the legal entity. |
Referenced models: Edit a legal entity — request body — body data address, Edit a legal entity — request body — body data company identifiers
Edit a legal entity — request body — body data address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | string | Optional | The city. |
country | string | Optional | The ISO 2-letter country code. Pattern: ^[A-Z]{2}$ |
state | string | Optional | The state. |
street | string | Optional | The street address. |
Edit a legal entity — request body — body data company identifiers
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identifiers associated with the legal entity. |
registration_number | string | Optional | The registration number of the legal entity. |
tax_number | string | Optional | The tax identification number of the legal entity. |
Get registration tax identifier fields for a country — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Get registration tax identifier fields for a country — 200 response body — data |
Referenced models: Get registration tax identifier fields for a country — 200 response body — data
Get registration tax identifier fields for a country — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country_code | string | Optional | ISO 3166-1 alpha-2 country code, uppercased. |
fields | array | Optional | Empty when the country is recognized but has no configured identifier fields. |
fields[] | Model | Each item | Expand Get registration tax identifier fields for a country — 200 response body — data fields item |
Referenced models: Get registration tax identifier fields for a country — 200 response body — data fields item
Get registration tax identifier fields for a country — 200 response body — data fields item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
kind | string | Optional | Whether this field is a registration or tax identifier. Known values: registration_id, tax_id |
name | string | Optional | Human-readable name of the identifier field. |
requirement | string | Optional | `mandatory` — must be collected and submitted. `optional` — may be submitted but is not required. `bypass` — not required; clients should omit it unless they have a value, since if provided it may still be validated. Known values: mandatory, optional, bypass |
validation_regex | JSON | Optional | |
validation_regex (anyOf 1) | string | Alternative | Regex the submitted value must match. `null` when the field has no format restriction. |
validation_regex (anyOf 2) | null | Alternative | Regex the submitted value must match. `null` when the field has no format restriction. |
List all industry subcategories — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of industry subcategories. |
data[] | Model | Each item | Expand List all industry subcategories — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more results available. |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to fetch the next page of results. |
next_cursor (anyOf 2) | null | Alternative | Cursor to fetch the next page of results. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of results matching the query. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: List all industry subcategories — 200 response body — data item
List all industry subcategories — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category_name | JSON | Required within parent | |
category_name (anyOf 1) | string | Alternative | Name of the associated industry category. |
category_name (anyOf 2) | null | Alternative | Name of the associated industry category. |
created_at | string | Required within parent | Date and time when the subcategory was created. Format: date-time |
id | string | Required within parent | UUID of the subcategory. Format: uuid |
name | string | Required within parent | Name of the industry subcategory. |
updated_at | string | Required within parent | Date and time when the subcategory was last updated. Format: date-time |
List of legal entities — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand List of legal entities — 200 response body — data item |
page | Model | Optional | Expand List of legal entities — 200 response body — page |
Referenced models: List of legal entities — 200 response body — data item, List of legal entities — 200 response body — page
List of legal entities — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (anyOf 1) | Model | Alternative | Expand List of legal entities — 200 response body — data item address city, country, state, street, zip |
address (anyOf 2) | null | Alternative | |
archived_at | JSON | Optional | |
archived_at (anyOf 1) | string | Alternative | Archived date Format: date-time |
archived_at (anyOf 2) | null | Alternative | Archived date Format: date-time |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Country of the legal entity |
country (anyOf 2) | null | Alternative | Country of the legal entity |
created_at | string | Optional | Created date Format: date-time |
entity_subtype | string | Optional | Entity sub type |
entity_type | JSON | Optional | Entity type |
entity_type (anyOf 1) | string | Alternative | Entity type Known values: individual, company, light |
entity_type (anyOf 2) | null | Alternative | |
id | string | Optional | Id of the legal entity |
industry_name | JSON | Optional | |
industry_name (anyOf 1) | string | Alternative | Industry name |
industry_name (anyOf 2) | null | Alternative | Industry name |
name | string | Optional | Name of the legal entity |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Phone number |
phone (anyOf 2) | null | Alternative | Phone number |
registrationNumber | JSON | Optional | |
registrationNumber (anyOf 1) | string | Alternative | Registration number |
registrationNumber (anyOf 2) | null | Alternative | Registration number |
sic_number | JSON | Optional | |
sic_number (anyOf 1) | string | Alternative | SIC Company Identifier |
sic_number (anyOf 2) | null | Alternative | SIC Company Identifier |
status | string | Optional | The mapped legal entity lifecycle status, the same value as on the single legal entity endpoint. Returned only when the feature is enabled for the organization. Known values: archived, active, draft, processing, processing_draft, pending_verification, awaiting_review, unknown |
updated_at | string | Optional | Updated date Format: date-time |
vat_id | JSON | Optional | |
vat_id (anyOf 1) | string | Alternative | VAT ID |
vat_id (anyOf 2) | null | Alternative | VAT ID |
Referenced models: List of legal entities — 200 response body — data item address city, country, state, street, zip
List of legal entities — 200 response body — data item address city, country, state, street, zip
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | JSON | Optional | |
city (anyOf 1) | string | Alternative | City |
city (anyOf 2) | null | Alternative | City |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Country |
country (anyOf 2) | null | Alternative | Country |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | State |
state (anyOf 2) | null | Alternative | State |
street | JSON | Optional | |
street (anyOf 1) | string | Alternative | Street |
street (anyOf 2) | null | Alternative | Street |
zip | JSON | Optional | |
zip (anyOf 1) | string | Alternative | Zip code |
zip (anyOf 2) | null | Alternative | Zip code |
List of legal entities — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | JSON | Optional | |
cursor (anyOf 1) | string | Alternative | Cursor link |
cursor (anyOf 2) | null | Alternative | Cursor link |
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. |
Retrieve the KYB state of a legal entity — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approved_at | JSON | Required within parent | |
approved_at (anyOf 1) | string | Alternative | When the entity was approved; null otherwise. Format: date-time |
approved_at (anyOf 2) | null | Alternative | When the entity was approved; null otherwise. Format: date-time |
documents | JSON | Required within parent | |
documents (anyOf 1) | array | Alternative | Presence of every company-level document type. Null when `is_detail_available` is false. |
documents (anyOf 1)[] | Model | Each item | Expand Retrieve the KYB state of a legal entity — 200 response body — data documents null item |
documents (anyOf 2) | null | Alternative | Presence of every company-level document type. Null when `is_detail_available` is false. |
documents (anyOf 2)[] | Model | Each item | Expand Retrieve the KYB state of a legal entity — 200 response body — data documents null item |
edd | JSON | Required within parent | The 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) | Model | Alternative | Expand Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED |
edd (anyOf 2) | null | Alternative | |
is_action_required | boolean | Required within parent | True 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_available | boolean | Required within parent | False 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_id | string | Required within parent | Public id of the legal entity. Format: uuid |
persons | JSON | Required within parent | |
persons (anyOf 1) | array | Alternative | Declared 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)[] | Model | Each item | Expand Retrieve the KYB state of a legal entity — 200 response body — data persons null item |
persons (anyOf 2) | null | Alternative | Declared 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)[] | Model | Each item | Expand Retrieve the KYB state of a legal entity — 200 response body — data persons null item |
questionnaire | JSON | Required within parent | The 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) | Model | Alternative | Expand Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id |
questionnaire (anyOf 2) | null | Alternative | |
rejected_at | JSON | Required within parent | |
rejected_at (anyOf 1) | string | Alternative | When the entity was last rejected; null otherwise. Format: date-time |
rejected_at (anyOf 2) | null | Alternative | When the entity was last rejected; null otherwise. Format: date-time |
rejection | JSON | Required within parent | Present only when the entity was rejected; null otherwise. |
rejection (anyOf 1) | Model | Alternative | Expand Retrieve the KYB state of a legal entity — 200 response body — data rejection rejected at |
rejection (anyOf 2) | null | Alternative | |
requirements | JSON | Required within parent | |
requirements (anyOf 1) | array | Alternative | Everything 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)[] | Model | Each item | Expand Retrieve the KYB state of a legal entity — 200 response body — data requirements null item |
requirements (anyOf 2) | null | Alternative | Everything 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)[] | Model | Each item | Expand Retrieve the KYB state of a legal entity — 200 response body — data requirements null item |
status | string | Required within parent | The 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_at | JSON | Required within parent | |
submitted_at (anyOf 1) | string | Alternative | When the verification record was created; null before the first submission. Format: date-time |
submitted_at (anyOf 2) | null | Alternative | When the verification record was created; null before the first submission. Format: date-time |
verification_type | JSON | Required within parent | Depth of verification the entity is subject to, when known. |
verification_type (anyOf 1) | string | Alternative | Depth of verification the entity is subject to, when known. Known values: NONE, LIGHT, FULL |
verification_type (anyOf 2) | null | Alternative |
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 / edd / status: AWAITING ANSWERS, ANSWERED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The 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). |
id | string | Required within parent | Public id of the EDD request. Send it as `edd_request_id` when answering. Format: uuid |
is_answerable_over_api | boolean | Required within parent | False when the form has a required unsupported question. Contact Deel support to clear such a request. |
questions | array | Required within parent | Every question of the EDD form, in form order. |
questions[] | Model | Each item | Expand Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item |
requested_at | JSON | Required within parent | |
requested_at (anyOf 1) | string | Alternative | When Deel requested the EDD. Format: date-time |
requested_at (anyOf 2) | null | Alternative | When Deel requested the EDD. Format: date-time |
status | string | Required 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
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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Set when this question belongs to a repeatable group (e.g. "add another director"); null otherwise. |
index | JSON | Required within parent | |
index (anyOf 1) | integer | Alternative | Zero-based position of this question within its repeat group instance. |
index (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_repeats | JSON | Required within parent | |
max_repeats (anyOf 1) | integer | Alternative | Maximum number of instances of this group the form allows. |
max_repeats (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | Name of the repeatable group this question belongs to. |
Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item revealed when null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
equals | string | Required within parent | Option title `question` must be answered with for this question to apply. |
question | string | Required within parent | Key of the question whose answer gates this one. |
Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | 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. Known values: TEXT, LONG_TEXT, NUMBER, EMAIL, PHONE_NUMBER, DATE, DATE_RANGE, ADDRESS, SINGLE_CHOICE, MULTIPLE_CHOICE, COUNTRY, STATE, CURRENCY, DOCUMENT_UPLOAD, UNSUPPORTED |
Retrieve the KYB state of a legal entity — 200 response body — data documents null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_provided | boolean | Required within parent | Whether a file for this document has been submitted. File contents and URLs are never returned. |
is_required | boolean | Required within parent | Whether the verification service currently requires this document. |
meta_type | JSON | Required within parent | Kind of Proof of Authority document, when this entry's type is PROOF_OF_AUTHORITY. Null for every other document type. |
meta_type (anyOf 1) | string | Alternative | Kind 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) | null | Alternative | |
type | string | Required within parent | Company-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 persons null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
first_name | string | Required within parent | First name as declared. |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Public id of the declared person, when the verification service has assigned one. Format: uuid |
id (anyOf 2) | null | Alternative | Public id of the declared person, when the verification service has assigned one. Format: uuid |
last_name | string | Required within parent | Last name as declared. |
ownership_percentage | JSON | Required within parent | |
ownership_percentage (anyOf 1) | JSON | Alternative | |
ownership_percentage (anyOf 1) (anyOf 1) | number | Alternative | Declared ownership percentage for owners; null otherwise. Format: double |
ownership_percentage (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ownership_percentage (anyOf 2) | null | Alternative | Declared ownership percentage for owners; null otherwise. Format: double |
responsibilities | array | Required within parent | Roles the person holds in the entity. |
responsibilities[] | string | Each item | Known values: submitter, controllingOfficer, owner, director |
Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The 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. |
answers | JSON | Required within parent | |
answers (anyOf 1) | array | Alternative | The answers the verification service has saved. Null until answers are saved. |
answers (anyOf 1)[] | Model | Each item | Expand Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id answers null item |
answers (anyOf 2) | null | Alternative | The answers the verification service has saved. Null until answers are saved. |
answers (anyOf 2)[] | Model | Each item | Expand Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id answers null item |
display_name | string | Required within parent | Display name of the template. |
questions | array | Required within parent | Every question of the questionnaire, in template order. |
questions[] | Model | Each item | Expand Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id questions item |
template_id | JSON | Required within parent | |
template_id (anyOf 1) | integer | Alternative | Id of the questionnaire template that applies. Send it as `template_id` when answering. |
template_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id answers null item, Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id questions item
Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id answers null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_document_provided | boolean | Optional | Present only for a document question that has an uploaded document. It says a document exists; it never gives the file. |
question_key | string | Required within parent | The `key` of the question answered. Maximum length: 64 |
value | Model | Required within parent | Expand Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id answers null item value The saved answer, in the form the question type takes. It is null for a document question: the file is never returned. |
Referenced models: Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id answers null item value
Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id answers null item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The saved answer, in the form the question type takes. It is null for a document question: the file is never returned. |
$ (anyOf 1) | string | Alternative | Maximum length: 500 |
$ (anyOf 2) | array | Alternative | |
$ (anyOf 2)[] | string | Each item | Maximum length: 1000 |
Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id 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 be answered when it applies. A question with `revealed_when` applies only when one of its conditions is met. |
key | string | Required within parent | Key of the question within the questionnaire. 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 | |
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 questionnaire answers, display name, questions, template id questions item type What kind of answer the question takes. `SINGLE_CHOICE`: the text of one option (a yes/no question has the options `Yes` and `No`). `MULTIPLE_CHOICE`: a list of option texts. `TEXT`: a string. `DOCUMENT_UPLOAD`: a list with exactly one handle from `POST /rest/legal-entities/{legal_entity_id}/kyb/documents`, uploaded with `document_type` `QUESTIONNAIRE_DOCUMENT`. |
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 questionnaire answers, display name, questions, template id questions item type
Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id questions item type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | What kind of answer the question takes. `SINGLE_CHOICE`: the text of one option (a yes/no question has the options `Yes` and `No`). `MULTIPLE_CHOICE`: a list of option texts. `TEXT`: a string. `DOCUMENT_UPLOAD`: a list with exactly one handle from `POST /rest/legal-entities/{legal_entity_id}/kyb/documents`, uploaded with `document_type` `QUESTIONNAIRE_DOCUMENT`. Known values: TEXT, LONG_TEXT, NUMBER, EMAIL, PHONE_NUMBER, DATE, DATE_RANGE, ADDRESS, SINGLE_CHOICE, MULTIPLE_CHOICE, COUNTRY, STATE, CURRENCY, DOCUMENT_UPLOAD, UNSUPPORTED |
Retrieve the KYB state of a legal entity — 200 response body — data rejection rejected at
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Present only when the entity was rejected; null otherwise. |
rejected_at | JSON | Required within parent | |
rejected_at (anyOf 1) | string | Alternative | When the rejection was recorded. Format: date-time |
rejected_at (anyOf 2) | null | Alternative | When the rejection was recorded. Format: date-time |
Retrieve the KYB state of a legal entity — 200 response body — data requirements null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category | string | Required within parent | What kind of input satisfies the requirement: a company field, a company document, an attribute of a declared person, or the industry questionnaire (`INDUSTRY_QUESTIONNAIRE`, answered in `questionnaire` of the submission and described in the `questionnaire` block of this state). Known values: FIELD, DOCUMENT, PERSON, QUESTIONNAIRE |
is_satisfied | boolean | Required within parent | Whether the current submission already satisfies the requirement. |
key | string | Required within parent | Requirement key as published by the verification service, e.g. `FORMATION_DATE`, `ARTICLES_OF_INCORPORATION`, `PROOF_OF_AUTHORITY`, `UBO_NAME`, `DIRECTOR_KYC_DOCUMENT`. Person-level keys are prefixed with the role they constrain: `DIRECTOR_`, `CONTROLLING_OFFICER_`, `UBO_` or `SUBMITTER_`. |
Submit EDD request answers for a legal entity — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
answers | array | Required within parent | One answer per question key. Every required question needs an answer. |
answers[] | Model | Each item | Expand Submit EDD request answers for a legal entity — request body — body data answers item |
edd_request_id | string | Required within parent | The `edd.id` from the KYB state. A request that is no longer the open one is refused. Format: uuid |
Referenced models: Submit EDD request answers for a legal entity — request body — body data answers item
Submit EDD request answers for a legal entity — request body — body data answers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
question_key | string | Required within parent | The `key` of the question being answered. Maximum length: 16 |
value | Model | Required within parent | Expand Submit EDD request answers for a legal entity — request body — body data answers item value The answer. `TEXT`, `LONG_TEXT`, `EMAIL`, `PHONE_NUMBER`: a string. `NUMBER`: a number. `DATE`: `YYYY-MM-DD`. `DATE_RANGE`: an object with `start_date` and `end_date`. `ADDRESS`: an object with `country` (ISO 3166-1 alpha-2 code), `state`, `city`, `street`, `number` and `zip_code`; all six are required when the question is required. `SINGLE_CHOICE`: one option title. `MULTIPLE_CHOICE`: a list of option titles. `DOCUMENT_UPLOAD`: a list of document handles from `POST /rest/legal-entities/{legal_entity_id}/kyb/edd/documents`. An empty value leaves an optional question unanswered. |
Referenced models: Submit EDD request answers for a legal entity — request body — body data answers item value
Submit EDD request answers for a legal entity — request body — body data answers item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The answer. `TEXT`, `LONG_TEXT`, `EMAIL`, `PHONE_NUMBER`: a string. `NUMBER`: a number. `DATE`: `YYYY-MM-DD`. `DATE_RANGE`: an object with `start_date` and `end_date`. `ADDRESS`: an object with `country` (ISO 3166-1 alpha-2 code), `state`, `city`, `street`, `number` and `zip_code`; all six are required when the question is required. `SINGLE_CHOICE`: one option title. `MULTIPLE_CHOICE`: a list of option titles. `DOCUMENT_UPLOAD`: a list of document handles from `POST /rest/legal-entities/{legal_entity_id}/kyb/edd/documents`. An empty value leaves an optional question unanswered. |
$ (oneOf 1) | string | Alternative | Maximum length: 10000 |
$ (oneOf 2) | number | Alternative | Format: double |
$ (oneOf 3) | array | Alternative | |
$ (oneOf 3)[] | string | Each item | |
$ (oneOf 4) | Model | Alternative | Expand Submit EDD request answers for a legal entity — request body — body data answers item value city, country, end date, number, start date, state, street, zip code |
Referenced models: Submit EDD request answers for a legal entity — request body — body data answers item value city, country, end date, number, start date, state, street, zip code
Submit EDD request answers for a legal entity — request body — body data answers item value city, country, end date, number, start date, state, street, zip code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A date range (`DATE_RANGE`: `start_date` and `end_date`) or an address (`ADDRESS`: `country`, `state`, `city`, `street`, `number` and `zip_code`). |
city | string or null | Optional | `ADDRESS` only. |
country | string or null | Optional | `ADDRESS` only. ISO 3166-1 alpha-2 code. |
end_date | string or null | Optional | `DATE_RANGE` only. `YYYY-MM-DD`. |
number | string or null | Optional | `ADDRESS` only. |
start_date | string or null | Optional | `DATE_RANGE` only. `YYYY-MM-DD`. |
state | string or null | Optional | `ADDRESS` only. |
street | string or null | Optional | `ADDRESS` only. |
zip_code | string or null | Optional | `ADDRESS` only. |
Submit KYB information for a legal entity — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
documents | Model | Optional | Expand Submit KYB information for a legal entity — request body — body data documents Company documents as handles from the upload endpoint. Supply the ones the KYB state lists as required. |
formation_date | string | Optional | Company formation date, `YYYY-MM-DD`. Format: date |
is_declaration_confirmed | boolean | Required within parent | Must be true: the client confirms the information is accurate and complete. |
is_person_with_significant_control | boolean | Optional | Declares that the submitter personally holds significant control of the company (an owner, director or controlling officer) — the declared submitter in `persons[]` should hold one of those responsibilities too. An alternative to `proof_of_authority`: when `true`, the verification service waives the Proof of Authority document requirement. Omit or set `false` if the submitter is acting on the company's behalf without significant control themselves. |
is_terms_and_conditions_accepted | boolean | Required within parent | Must be true: the client accepts the verification terms and conditions. |
persons | array | Required within parent | Persons of significant control: directors, controlling officers, owners and the client-side submitter. |
persons[] | Model | Each item | Expand Submit KYB information for a legal entity — request body — body data persons item |
proof_of_authority | Model | Optional | Expand Submit KYB information for a legal entity — request body — body data proof of authority Proof of Authority for the person acting on behalf of the entity. Required when the KYB state lists `PROOF_OF_AUTHORITY` as outstanding, unless `is_person_with_significant_control` is `true`. |
questionnaire | Model | Optional | Expand Submit KYB information for a legal entity — request body — body data questionnaire Answers to the industry questionnaire. Required when the KYB state lists the `INDUSTRY_QUESTIONNAIRE` requirement, refused when no questionnaire applies. |
transaction_monthly_volume | string | Optional | Expected monthly transaction volume range. One of: LESS_THAN_1K, BETWEEN_1K_AND_10K, BETWEEN_10K_AND_100K, BETWEEN_100K_AND_1M, GREATER_THAN_1M |
Referenced models: Submit KYB information for a legal entity — request body — body data documents, Submit KYB information for a legal entity — request body — body data persons item, Submit KYB information for a legal entity — request body — body data proof of authority, Submit KYB information for a legal entity — request body — body data questionnaire
Submit KYB information for a legal entity — request body — body data documents
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Company documents as handles from the upload endpoint. Supply the ones the KYB state lists as required. |
articles_of_incorporation | string | Optional | Handle of a document uploaded as `ARTICLES_OF_INCORPORATION`. Format: uuid |
certificate_of_good_standing | string | Optional | Handle of a document uploaded as `CERTIFICATE_OF_GOOD_STANDING`. Format: uuid |
company_bank_statement | string | Optional | Handle of a document uploaded as `COMPANY_BANK_STATEMENT`. Format: uuid |
ultimate_beneficial_owner_form | string | Optional | Handle of a document uploaded as `ULTIMATE_BENEFICIAL_OWNER_FORM`. Format: uuid |
Submit KYB information for a legal entity — request body — body data persons item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Optional | Expand Submit KYB information for a legal entity — request body — body data persons item address Residential address. |
citizenship | string | Optional | Citizenship as an ISO 3166-1 alpha-2 country code. |
date_of_birth | string | Optional | Date of birth, `YYYY-MM-DD`. Format: date |
first_name | string | Required within parent | First name. Maximum length: 255 |
identification_document_type | string | Optional | Type of the identity document supplied in `identity_documents`. One of: PASSPORT, DRIVERS_LICENSE, ID_DOCUMENT |
identity_documents | Model | Optional | Expand Submit KYB information for a legal entity — request body — body data persons item identity documents Identity document sides and selfie for the person, as upload handles. |
job_title | Model | Optional | Expand Submit KYB information for a legal entity — request body — body data persons item job title Role of the person in the company, from the verification service vocabulary; required for controlling officers when the verification service asks for it. |
last_name | string | Required within parent | Last name. Maximum length: 255 |
middle_name | string or null | Optional | Middle name, when any. Maximum length: 255 |
ownership_percentage | number | Optional | Ownership percentage; required for owners when the verification service asks for it. Format: double Maximum: 100 Minimum: 0 |
responsibilities | array | Required within parent | Roles the person holds in the entity. `submitter` marks the person who authorised the submission on the client side. |
responsibilities[] | string | Each item | One of: submitter, controllingOfficer, owner, director |
tax_id | string | Optional | Personal tax identifier. Maximum length: 64 |
Referenced models: Submit KYB information for a legal entity — request body — body data persons item address, Submit KYB information for a legal entity — request body — body data persons item identity documents, Submit KYB information for a legal entity — request body — body data persons item job title
Submit KYB information for a legal entity — request body — body data persons item address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Residential address. |
city | string | Required within parent | City. Maximum length: 255 |
country | string | Required within parent | ISO 3166-1 alpha-2 country code. |
state | string or null | Optional | State or province. Required for US addresses, as a 2-letter ISO 3166-2 code (e.g. `CA`). Maximum length: 64 |
street | string | Required within parent | Street address. Maximum length: 255 |
zip | string | Required within parent | Postal code. Maximum length: 32 |
Submit KYB information for a legal entity — request body — body data persons item identity documents
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identity document sides and selfie for the person, as upload handles. |
back | string | Optional | Handle of a document uploaded as `IDENTITY_DOCUMENT_BACK`. Not needed for passports. Format: uuid |
front | string | Optional | Handle of a document uploaded as `IDENTITY_DOCUMENT_FRONT`. Format: uuid |
selfie | string | Optional | Handle of a document uploaded as `SELFIE`. Format: uuid |
Submit KYB information for a legal entity — request body — body data persons item job title
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Role of the person in the company, from the verification service vocabulary; required for controlling officers when the verification service asks for it. One of: FOUNDER, MAJOR_SHAREHOLDER, MINORITY_SHAREHOLDER, EQUITY_PARTNER, EXECUTIVE_C_LEVEL, MANAGING_DIRECTOR, DIRECTOR, PRESIDENT, VICE_PRESIDENT, SENIOR_MANAGEMENT_OFFICIAL, AUTHORIZED_SIGNATORY, OTHER |
Submit KYB information for a legal entity — request body — body data proof of authority
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Proof of Authority for the person acting on behalf of the entity. Required when the KYB state lists `PROOF_OF_AUTHORITY` as outstanding, unless `is_person_with_significant_control` is `true`. |
document | string | Required within parent | Handle of a document uploaded as `PROOF_OF_AUTHORITY`. Format: uuid |
meta_type | string | Required within parent | What kind of document evidences the authority: a power of attorney, a board resolution or minutes, or another document. One of: POWER_OF_ATTORNEY, RESOLUTION_OR_MINUTES, OTHER |
Submit KYB information for a legal entity — request body — body data questionnaire
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Answers to the industry questionnaire. Required when the KYB state lists the `INDUSTRY_QUESTIONNAIRE` requirement, refused when no questionnaire applies. |
answers | array | Required within parent | One answer per question that applies. Answers to questions that do not currently apply are ignored. |
answers[] | Model | Each item | Expand Submit KYB information for a legal entity — request body — body data questionnaire answers item |
template_id | integer | Required within parent | The `questionnaire.template_id` from the KYB state. |
Referenced models: Submit KYB information for a legal entity — request body — body data questionnaire answers item
Submit KYB information for a legal entity — request body — body data questionnaire answers item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
question_key | string | Required within parent | The `key` of the question answered. Maximum length: 64 |
value | Model | Required within parent | Expand Submit KYB information for a legal entity — request body — body data questionnaire answers item value The answer, in the form the question type takes. For a document question, send a list with one document handle. |
Referenced models: Submit KYB information for a legal entity — request body — body data questionnaire answers item value
Submit KYB information for a legal entity — request body — body data questionnaire answers item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The answer, in the form the question type takes. For a document question, send a list with one document handle. |
$ (oneOf 1) | string | Alternative | Maximum length: 500 |
$ (oneOf 2) | array | Alternative | |
$ (oneOf 2)[] | string | Each item | Maximum length: 1000 |
Update GP employee app access for a legal entity — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Update GP employee app access for a legal entity — 200 response body — data |
Referenced models: Update GP employee app access for a legal entity — 200 response body — data
Update GP employee app access for a legal entity — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
key | string | Optional | The setting key that was updated. |
value | string | Optional | The setting value that was applied. |
Update GP employee app access for a legal entity — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
key | string | Required within parent | The setting key to update. Only ALLOW_GP_EMPLOYEE_APP_ACCESS is supported today. One of: ALLOW_GP_EMPLOYEE_APP_ACCESS |
value | string | Required within parent | Set to "true" to grant employees access to the Deel app, or "false" to revoke it. One of: true, false |
Upload a KYB document for a legal entity — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Upload a KYB document for a legal entity — 201 response body — data |
Referenced models: Upload a KYB document for a legal entity — 201 response body — data
Upload a KYB document for a legal entity — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
content_type | string | Required within parent | MIME type of the stored file. |
created_at | string | Required within parent | When the document was uploaded. Format: date-time |
document_type | string | Required within parent | The document type the file was uploaded as. The handle can only be used for this type. Known values: ARTICLES_OF_INCORPORATION, COMPANY_BANK_STATEMENT, CERTIFICATE_OF_GOOD_STANDING, ULTIMATE_BENEFICIAL_OWNER_FORM, PROOF_OF_AUTHORITY, IDENTITY_DOCUMENT_FRONT, IDENTITY_DOCUMENT_BACK, SELFIE, QUESTIONNAIRE_DOCUMENT |
expires_at | string | Required within parent | When the handle stops being accepted if it has not been used in a submission. Format: date-time |
file_name | JSON | Required within parent | |
file_name (anyOf 1) | string | Alternative | Original file name, when the upload carried one. |
file_name (anyOf 2) | null | Alternative | Original file name, when the upload carried one. |
id | string | Required within parent | Opaque handle for the uploaded document. Pass it in the matching document field of `POST /rest/legal-entities/{legal_entity_id}/kyb`. Valid only for this legal entity, usable once, and expires if unused. Format: uuid |
Upload a document for an EDD request of a legal entity — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Upload a document for an EDD request of a legal entity — 201 response body — data |
Referenced models: Upload a document for an EDD request of a legal entity — 201 response body — data
Upload a document for an EDD request of a legal entity — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | When the document was uploaded. Format: date-time |
expires_at | string | Required within parent | When the handle stops being accepted if it has not been used in an answer. Format: date-time |
id | string | Required within parent | Opaque handle for the uploaded document. Pass it in the matching answer of `POST /rest/legal-entities/{legal_entity_id}/kyb/edd`. Valid only for this legal entity, EDD request and question, usable once, and expires if unused. Format: uuid |
question_key | string | Required within parent | The EDD question key the file was uploaded for. The handle can only be used for this question. |