Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
addressModelOptionalExpand Create a new legal entity — 200 response body — data address
The entity's address.
created_atstringOptionalTimestamp when the entity was created.
Format: date-time
entity_typestringOptionalType of the entity.
idstringOptionalThe unique identifier for the legal entity.
namestringOptionalThe name of the entity.
phonestringOptionalThe contact number of the entity.
sic_numberstringOptionalThe SIC number of the entity.
updated_atstringOptionalTimestamp 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

FieldTypePresenceDescription and constraints
$objectRootThe entity's address.
citystringOptional
countrystringOptional
statestringOptional
streetstringOptional
zipstringOptional

Create a new legal entity — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
addressModelRequired within parentExpand Create a new legal entity — request body — body data address
The physical address of the entity.
company_identifiersModelRequired within parentExpand Create a new legal entity — request body — body data company identifiers
entity_typestringRequired within parentType of the entity.
namestringRequired within parentThe legal name of the entity.
phonestringRequired within parentContact phone number for the entity.
sic_numberstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootThe physical address of the entity.
citystringRequired within parentCity name.
countrystringRequired within parentCountry code.
statestringOptionalState
streetstringRequired within parentStreet address.
zipstringRequired within parentZip code.

Create a new legal entity — request body — body data company identifiers

FieldTypePresenceDescription and constraints
$objectRoot
registration_numberstringRequired within parentRegistration number of the entity.
tax_numberstringRequired within parentTax number of the entity.

Delete a legal entity — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
archived_atstringOptionalThe timestamp when the legal entity was archived.
Format: date-time

Edit a legal entity — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
addressModelOptionalExpand Edit a legal entity — 200 response body — data address
company_identifiersModelOptionalExpand Edit a legal entity — 200 response body — data company identifiers
entity_typestringOptionalThe type of the legal entity.
idstringOptionalThe unique identifier of the legal entity.
industry_namestringOptionalThe industry name of the legal entity.
namestringOptionalThe name of the legal entity.
phonestringOptionalThe phone number of the legal entity.
sic_numberstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
citystringOptionalThe city.
countrystringOptionalThe ISO 2-letter country code.
statestringOptionalThe state.
streetstringOptionalThe street address.

Edit a legal entity — 200 response body — data company identifiers

FieldTypePresenceDescription and constraints
$objectRoot
registration_numberstringOptionalThe registration number of the legal entity.
tax_numberstringOptionalThe tax identification number of the legal entity.

Edit a legal entity — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
addressModelOptionalExpand Edit a legal entity — request body — body data address
company_identifiersModelOptionalExpand Edit a legal entity — request body — body data company identifiers
Identifiers associated with the legal entity.
deel_industry_subcategory_idstringOptionalReference to the Deel Industry Code (NAICS).
entity_typestringOptionalThe type of the legal entity.
industry_namestringOptionalThe industry name of the legal entity.
namestringOptionalThe name of the legal entity.
phonestringOptionalThe phone number of the legal entity.
sic_numberstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
citystringOptionalThe city.
countrystringOptionalThe ISO 2-letter country code.
Pattern: ^[A-Z]{2}$
statestringOptionalThe state.
streetstringOptionalThe street address.

Edit a legal entity — request body — body data company identifiers

FieldTypePresenceDescription and constraints
$objectRootIdentifiers associated with the legal entity.
registration_numberstringOptionalThe registration number of the legal entity.
tax_numberstringOptionalThe tax identification number of the legal entity.

Get registration tax identifier fields for a country — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
country_codestringOptionalISO 3166-1 alpha-2 country code, uppercased.
fieldsarrayOptionalEmpty when the country is recognized but has no configured identifier fields.
fields[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
kindstringOptionalWhether this field is a registration or tax identifier.
Known values: registration_id, tax_id
namestringOptionalHuman-readable name of the identifier field.
requirementstringOptional`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_regexJSONOptional
validation_regex (anyOf 1)stringAlternativeRegex the submitted value must match. `null` when the field has no format restriction.
validation_regex (anyOf 2)nullAlternativeRegex the submitted value must match. `null` when the field has no format restriction.

List all industry subcategories — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of industry subcategories.
data[]ModelEach itemExpand List all industry subcategories — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more results available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to fetch the next page of results.
next_cursor (anyOf 2)nullAlternativeCursor to fetch the next page of results.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of results matching the query.
total_count (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
category_nameJSONRequired within parent
category_name (anyOf 1)stringAlternativeName of the associated industry category.
category_name (anyOf 2)nullAlternativeName of the associated industry category.
created_atstringRequired within parentDate and time when the subcategory was created.
Format: date-time
idstringRequired within parentUUID of the subcategory.
Format: uuid
namestringRequired within parentName of the industry subcategory.
updated_atstringRequired within parentDate and time when the subcategory was last updated.
Format: date-time

List of legal entities — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand List of legal entities — 200 response body — data item
pageModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (anyOf 1)ModelAlternativeExpand List of legal entities — 200 response body — data item address city, country, state, street, zip
address (anyOf 2)nullAlternative
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeArchived date
Format: date-time
archived_at (anyOf 2)nullAlternativeArchived date
Format: date-time
countryJSONOptional
country (anyOf 1)stringAlternativeCountry of the legal entity
country (anyOf 2)nullAlternativeCountry of the legal entity
created_atstringOptionalCreated date
Format: date-time
entity_subtypestringOptionalEntity sub type
entity_typeJSONOptionalEntity type
entity_type (anyOf 1)stringAlternativeEntity type
Known values: individual, company, light
entity_type (anyOf 2)nullAlternative
idstringOptionalId of the legal entity
industry_nameJSONOptional
industry_name (anyOf 1)stringAlternativeIndustry name
industry_name (anyOf 2)nullAlternativeIndustry name
namestringOptionalName of the legal entity
phoneJSONOptional
phone (anyOf 1)stringAlternativePhone number
phone (anyOf 2)nullAlternativePhone number
registrationNumberJSONOptional
registrationNumber (anyOf 1)stringAlternativeRegistration number
registrationNumber (anyOf 2)nullAlternativeRegistration number
sic_numberJSONOptional
sic_number (anyOf 1)stringAlternativeSIC Company Identifier
sic_number (anyOf 2)nullAlternativeSIC Company Identifier
statusstringOptionalThe 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_atstringOptionalUpdated date
Format: date-time
vat_idJSONOptional
vat_id (anyOf 1)stringAlternativeVAT ID
vat_id (anyOf 2)nullAlternativeVAT 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

FieldTypePresenceDescription and constraints
$objectRoot
cityJSONOptional
city (anyOf 1)stringAlternativeCity
city (anyOf 2)nullAlternativeCity
countryJSONOptional
country (anyOf 1)stringAlternativeCountry
country (anyOf 2)nullAlternativeCountry
stateJSONOptional
state (anyOf 1)stringAlternativeState
state (anyOf 2)nullAlternativeState
streetJSONOptional
street (anyOf 1)stringAlternativeStreet
street (anyOf 2)nullAlternativeStreet
zipJSONOptional
zip (anyOf 1)stringAlternativeZip code
zip (anyOf 2)nullAlternativeZip code

List of legal entities — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONOptional
cursor (anyOf 1)stringAlternativeCursor link
cursor (anyOf 2)nullAlternativeCursor link

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.

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 / 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

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

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeHelper text for the question, when any.
description (anyOf 2)nullAlternativeHelper text for the question, when any.
is_requiredbooleanRequired within parentWhether the question must currently be answered.
keystringRequired within parentKey of the question within this EDD request, in form order. Send it as `question_key` when answering.
optionsJSONRequired within parent
options (anyOf 1)arrayAlternativeFor `SINGLE_CHOICE` and `MULTIPLE_CHOICE` questions, the option titles to answer with. Null for every other type.
options (anyOf 1)[]stringEach item
options (anyOf 2)nullAlternativeFor `SINGLE_CHOICE` and `MULTIPLE_CHOICE` questions, the option titles to answer with. Null for every other type.
options (anyOf 2)[]stringEach item
repeat_groupJSONRequired within parentSet when this question belongs to a repeatable group (e.g. "add another director"); null otherwise.
repeat_group (anyOf 1)ModelAlternativeExpand 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)nullAlternative
revealed_whenJSONRequired within parent
revealed_when (anyOf 1)arrayAlternativeConditions 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)[]ModelEach itemExpand 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)nullAlternativeConditions 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)[]ModelEach itemExpand Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item revealed when null item
titlestringRequired within parentThe question as the reviewer wrote it.
typeModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootSet when this question belongs to a repeatable group (e.g. "add another director"); null otherwise.
indexJSONRequired within parent
index (anyOf 1)integerAlternativeZero-based position of this question within its repeat group instance.
index (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_repeatsJSONRequired within parent
max_repeats (anyOf 1)integerAlternativeMaximum number of instances of this group the form allows.
max_repeats (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringRequired within parentName 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

FieldTypePresenceDescription and constraints
$objectRoot
equalsstringRequired within parentOption title `question` must be answered with for this question to apply.
questionstringRequired within parentKey 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

FieldTypePresenceDescription and constraints
$stringRootWhat 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

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 persons null item

FieldTypePresenceDescription and constraints
$objectRoot
first_namestringRequired within parentFirst name as declared.
idJSONRequired within parent
id (anyOf 1)stringAlternativePublic id of the declared person, when the verification service has assigned one.
Format: uuid
id (anyOf 2)nullAlternativePublic id of the declared person, when the verification service has assigned one.
Format: uuid
last_namestringRequired within parentLast name as declared.
ownership_percentageJSONRequired within parent
ownership_percentage (anyOf 1)JSONAlternative
ownership_percentage (anyOf 1) (anyOf 1)numberAlternativeDeclared ownership percentage for owners; null otherwise.
Format: double
ownership_percentage (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ownership_percentage (anyOf 2)nullAlternativeDeclared ownership percentage for owners; null otherwise.
Format: double
responsibilitiesarrayRequired within parentRoles the person holds in the entity.
responsibilities[]stringEach itemKnown values: submitter, controllingOfficer, owner, director

Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id

FieldTypePresenceDescription and constraints
$objectRootThe 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.
answersJSONRequired within parent
answers (anyOf 1)arrayAlternativeThe answers the verification service has saved. Null until answers are saved.
answers (anyOf 1)[]ModelEach itemExpand 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)nullAlternativeThe answers the verification service has saved. Null until answers are saved.
answers (anyOf 2)[]ModelEach itemExpand Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id answers null item
display_namestringRequired within parentDisplay name of the template.
questionsarrayRequired within parentEvery question of the questionnaire, in template order.
questions[]ModelEach itemExpand Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id questions item
template_idJSONRequired within parent
template_id (anyOf 1)integerAlternativeId of the questionnaire template that applies. Send it as `template_id` when answering.
template_id (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
is_document_providedbooleanOptionalPresent only for a document question that has an uploaded document. It says a document exists; it never gives the file.
question_keystringRequired within parentThe `key` of the question answered.
Maximum length: 64
valueModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$JSONRootThe saved answer, in the form the question type takes. It is null for a document question: the file is never returned.
$ (anyOf 1)stringAlternativeMaximum length: 500
$ (anyOf 2)arrayAlternative
$ (anyOf 2)[]stringEach itemMaximum length: 1000

Retrieve the KYB state of a legal entity — 200 response body — data questionnaire answers, display name, questions, template id questions item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeHelper text for the question, when any.
description (anyOf 2)nullAlternativeHelper text for the question, when any.
is_requiredbooleanRequired within parentWhether the question must be answered when it applies. A question with `revealed_when` applies only when one of its conditions is met.
keystringRequired within parentKey of the question within the questionnaire. Send it as `question_key` when answering.
optionsJSONRequired within parent
options (anyOf 1)arrayAlternativeFor `SINGLE_CHOICE` and `MULTIPLE_CHOICE` questions, the option titles to answer with. Null for every other type.
options (anyOf 1)[]stringEach item
options (anyOf 2)nullAlternativeFor `SINGLE_CHOICE` and `MULTIPLE_CHOICE` questions, the option titles to answer with. Null for every other type.
options (anyOf 2)[]stringEach item
revealed_whenJSONRequired within parent
revealed_when (anyOf 1)arrayAlternativeConditions 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)[]ModelEach itemExpand 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)nullAlternativeConditions 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)[]ModelEach itemExpand Retrieve the KYB state of a legal entity — 200 response body — data / edd / status: AWAITING ANSWERS, ANSWERED questions item revealed when null item
titlestringRequired within parentThe question as the reviewer wrote it.
typeModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$stringRootWhat 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

FieldTypePresenceDescription and constraints
$objectRootPresent only when the entity was rejected; null otherwise.
rejected_atJSONRequired within parent
rejected_at (anyOf 1)stringAlternativeWhen the rejection was recorded.
Format: date-time
rejected_at (anyOf 2)nullAlternativeWhen the rejection was recorded.
Format: date-time

Retrieve the KYB state of a legal entity — 200 response body — data requirements null item

FieldTypePresenceDescription and constraints
$objectRoot
categorystringRequired within parentWhat 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_satisfiedbooleanRequired within parentWhether the current submission already satisfies the requirement.
keystringRequired within parentRequirement 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

FieldTypePresenceDescription and constraints
$objectRoot
answersarrayRequired within parentOne answer per question key. Every required question needs an answer.
answers[]ModelEach itemExpand Submit EDD request answers for a legal entity — request body — body data answers item
edd_request_idstringRequired within parentThe `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

FieldTypePresenceDescription and constraints
$objectRoot
question_keystringRequired within parentThe `key` of the question being answered.
Maximum length: 16
valueModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$JSONRootThe 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)stringAlternativeMaximum length: 10000
$ (oneOf 2)numberAlternativeFormat: double
$ (oneOf 3)arrayAlternative
$ (oneOf 3)[]stringEach item
$ (oneOf 4)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRootA date range (`DATE_RANGE`: `start_date` and `end_date`) or an address (`ADDRESS`: `country`, `state`, `city`, `street`, `number` and `zip_code`).
citystring or nullOptional`ADDRESS` only.
countrystring or nullOptional`ADDRESS` only. ISO 3166-1 alpha-2 code.
end_datestring or nullOptional`DATE_RANGE` only. `YYYY-MM-DD`.
numberstring or nullOptional`ADDRESS` only.
start_datestring or nullOptional`DATE_RANGE` only. `YYYY-MM-DD`.
statestring or nullOptional`ADDRESS` only.
streetstring or nullOptional`ADDRESS` only.
zip_codestring or nullOptional`ADDRESS` only.

Submit KYB information for a legal entity — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
documentsModelOptionalExpand 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_datestringOptionalCompany formation date, `YYYY-MM-DD`.
Format: date
is_declaration_confirmedbooleanRequired within parentMust be true: the client confirms the information is accurate and complete.
is_person_with_significant_controlbooleanOptionalDeclares 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_acceptedbooleanRequired within parentMust be true: the client accepts the verification terms and conditions.
personsarrayRequired within parentPersons of significant control: directors, controlling officers, owners and the client-side submitter.
persons[]ModelEach itemExpand Submit KYB information for a legal entity — request body — body data persons item
proof_of_authorityModelOptionalExpand 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`.
questionnaireModelOptionalExpand 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_volumestringOptionalExpected 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

FieldTypePresenceDescription and constraints
$objectRootCompany documents as handles from the upload endpoint. Supply the ones the KYB state lists as required.
articles_of_incorporationstringOptionalHandle of a document uploaded as `ARTICLES_OF_INCORPORATION`.
Format: uuid
certificate_of_good_standingstringOptionalHandle of a document uploaded as `CERTIFICATE_OF_GOOD_STANDING`.
Format: uuid
company_bank_statementstringOptionalHandle of a document uploaded as `COMPANY_BANK_STATEMENT`.
Format: uuid
ultimate_beneficial_owner_formstringOptionalHandle of a document uploaded as `ULTIMATE_BENEFICIAL_OWNER_FORM`.
Format: uuid

Submit KYB information for a legal entity — request body — body data persons item

FieldTypePresenceDescription and constraints
$objectRoot
addressModelOptionalExpand Submit KYB information for a legal entity — request body — body data persons item address
Residential address.
citizenshipstringOptionalCitizenship as an ISO 3166-1 alpha-2 country code.
date_of_birthstringOptionalDate of birth, `YYYY-MM-DD`.
Format: date
first_namestringRequired within parentFirst name.
Maximum length: 255
identification_document_typestringOptionalType of the identity document supplied in `identity_documents`.
One of: PASSPORT, DRIVERS_LICENSE, ID_DOCUMENT
identity_documentsModelOptionalExpand 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_titleModelOptionalExpand 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_namestringRequired within parentLast name.
Maximum length: 255
middle_namestring or nullOptionalMiddle name, when any.
Maximum length: 255
ownership_percentagenumberOptionalOwnership percentage; required for owners when the verification service asks for it.
Format: double
Maximum: 100
Minimum: 0
responsibilitiesarrayRequired within parentRoles the person holds in the entity. `submitter` marks the person who authorised the submission on the client side.
responsibilities[]stringEach itemOne of: submitter, controllingOfficer, owner, director
tax_idstringOptionalPersonal 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

FieldTypePresenceDescription and constraints
$objectRootResidential address.
citystringRequired within parentCity.
Maximum length: 255
countrystringRequired within parentISO 3166-1 alpha-2 country code.
statestring or nullOptionalState or province. Required for US addresses, as a 2-letter ISO 3166-2 code (e.g. `CA`).
Maximum length: 64
streetstringRequired within parentStreet address.
Maximum length: 255
zipstringRequired within parentPostal code.
Maximum length: 32

Submit KYB information for a legal entity — request body — body data persons item identity documents

FieldTypePresenceDescription and constraints
$objectRootIdentity document sides and selfie for the person, as upload handles.
backstringOptionalHandle of a document uploaded as `IDENTITY_DOCUMENT_BACK`. Not needed for passports.
Format: uuid
frontstringOptionalHandle of a document uploaded as `IDENTITY_DOCUMENT_FRONT`.
Format: uuid
selfiestringOptionalHandle of a document uploaded as `SELFIE`.
Format: uuid

Submit KYB information for a legal entity — request body — body data persons item job title

FieldTypePresenceDescription and constraints
$stringRootRole 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

FieldTypePresenceDescription and constraints
$objectRootProof 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`.
documentstringRequired within parentHandle of a document uploaded as `PROOF_OF_AUTHORITY`.
Format: uuid
meta_typestringRequired within parentWhat 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

FieldTypePresenceDescription and constraints
$objectRootAnswers to the industry questionnaire. Required when the KYB state lists the `INDUSTRY_QUESTIONNAIRE` requirement, refused when no questionnaire applies.
answersarrayRequired within parentOne answer per question that applies. Answers to questions that do not currently apply are ignored.
answers[]ModelEach itemExpand Submit KYB information for a legal entity — request body — body data questionnaire answers item
template_idintegerRequired within parentThe `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

FieldTypePresenceDescription and constraints
$objectRoot
question_keystringRequired within parentThe `key` of the question answered.
Maximum length: 64
valueModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$JSONRootThe answer, in the form the question type takes. For a document question, send a list with one document handle.
$ (oneOf 1)stringAlternativeMaximum length: 500
$ (oneOf 2)arrayAlternative
$ (oneOf 2)[]stringEach itemMaximum length: 1000

Update GP employee app access for a legal entity — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
keystringOptionalThe setting key that was updated.
valuestringOptionalThe setting value that was applied.

Update GP employee app access for a legal entity — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
keystringRequired within parentThe setting key to update. Only ALLOW_GP_EMPLOYEE_APP_ACCESS is supported today.
One of: ALLOW_GP_EMPLOYEE_APP_ACCESS
valuestringRequired within parentSet 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
content_typestringRequired within parentMIME type of the stored file.
created_atstringRequired within parentWhen the document was uploaded.
Format: date-time
document_typestringRequired within parentThe 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_atstringRequired within parentWhen the handle stops being accepted if it has not been used in a submission.
Format: date-time
file_nameJSONRequired within parent
file_name (anyOf 1)stringAlternativeOriginal file name, when the upload carried one.
file_name (anyOf 2)nullAlternativeOriginal file name, when the upload carried one.
idstringRequired within parentOpaque 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentWhen the document was uploaded.
Format: date-time
expires_atstringRequired within parentWhen the handle stops being accepted if it has not been used in an answer.
Format: date-time
idstringRequired within parentOpaque 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_keystringRequired within parentThe EDD question key the file was uploaded for. The handle can only be used for this question.

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.