Deel: Screenings schemas
15 Deel schemas with complete fields and constraints.
← Screenings operations · All schemas
Create Veriff session — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create Veriff session — 201 response body — data |
Referenced models: Create Veriff session — 201 response body — data
Create Veriff session — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
url | string | Required within parent | The URL of the Veriff session |
Create Veriff session — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
operation_type | string | Required within parent | The type of KYC operation to perform One of: IDENTITY_RESUBMISSION_KYC, IDENTITY_VERIFICATION_KYC, NAME_CHANGE_KYC, EMAIL_CHANGE_KYC |
user_input | Model | Optional | Expand Create Veriff session — request body — body data user input Input data for the name change KYC operation |
Referenced models: Create Veriff session — request body — body data user input
Create Veriff session — request body — body data user input
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Input data for the name change KYC operation |
first_name | string | Required within parent | The desired first name of the user |
last_name | string | Required within parent | The desired last name of the user |
middle_name | string or null | Optional | The desired middle name of the user |
Create manual verification screening — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Create manual verification screening — 201 response body — data |
Referenced models: Create manual verification screening — 201 response body — data
Create manual verification screening — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp when screening was successfully received and processed (ISO 8601) Format: date-time |
request_id | string | Required within parent | Unique request identifier |
Get entity screening details — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
detailed_results | Model | Required within parent | Expand Get entity screening details — 200 response body — detailed results Details of checks performed for this screening. |
entity_id | string | Required within parent | UUID of the entity. |
entity_type | string | Required within parent | The type of entity being screened. Known values: profile, hris_profile, legal_entity |
result | string | Required within parent | The result of the screening. ACCEPT means the screening passed, REJECT means it failed, and REFERRED means it is pending further review. Known values: ACCEPT, REJECT, REFERRED, PENDING |
Referenced models: Get entity screening details — 200 response body — detailed results
Get entity screening details — 200 response body — detailed results
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of checks performed for this screening. |
adverse_media | string | Optional | The result of the adverse media check. Known values: PASS, FAIL |
pep | string | Optional | The result of the PEP (Politically Exposed Person) check. Known values: PASS, FAIL |
sanctions | string | Optional | The result of the sanctions check. Known values: PASS, FAIL |
Get verification method — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get verification method — 200 response body — data |
Referenced models: Get verification method — 200 response body — data
Get verification method — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
verification_method | string | Required within parent | The supported method for KYC |
Get worker's KYC details — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get worker's KYC details — 200 response body — data |
Referenced models: Get worker's KYC details — 200 response body — data
Get worker's KYC details — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_date | JSON | Required within parent | |
approval_date (anyOf 1) | string | Alternative | The date and time when the KYC screening was approved (null if not approved) Format: date-time |
approval_date (anyOf 2) | null | Alternative | The date and time when the KYC screening was approved (null if not approved) Format: date-time |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | The date and time when the KYC screening was created Format: date-time |
created_at (anyOf 2) | null | Alternative | The date and time when the KYC screening was created Format: date-time |
document_extracted_first_name | JSON | Optional | |
document_extracted_first_name (anyOf 1) | string | Alternative | The first name extracted from the submitted document |
document_extracted_first_name (anyOf 2) | null | Alternative | The first name extracted from the submitted document |
document_extracted_last_name | JSON | Optional | |
document_extracted_last_name (anyOf 1) | string | Alternative | The last name extracted from the submitted document |
document_extracted_last_name (anyOf 2) | null | Alternative | The last name extracted from the submitted document |
document_extracted_middle_name | JSON | Required within parent | |
document_extracted_middle_name (anyOf 1) | string | Alternative | The middle name extracted from the submitted document |
document_extracted_middle_name (anyOf 2) | null | Alternative | The middle name extracted from the submitted document |
expiration_date | JSON | Required within parent | |
expiration_date (anyOf 1) | string | Alternative | The date and time when the KYC screening expires (null if no expiry) Format: date-time |
expiration_date (anyOf 2) | null | Alternative | The date and time when the KYC screening expires (null if no expiry) Format: date-time |
identity_document_name | JSON | Optional | |
identity_document_name (anyOf 1) | string | Alternative | The name of the identity document used for verification (in case of other document type) |
identity_document_name (anyOf 2) | null | Alternative | The name of the identity document used for verification (in case of other document type) |
identity_document_number | JSON | Optional | |
identity_document_number (anyOf 1) | string | Alternative | Number of the submitted document |
identity_document_number (anyOf 2) | null | Alternative | Number of the submitted document |
identity_document_type | JSON | Required within parent | The type of identity document used for verification |
identity_document_type (anyOf 1) | string | Alternative | The type of identity document used for verification Known values: DRIVING_LICENSE, PASSPORT, GOVERNMENT_ID, SELFIE_WITH_ID, PROOF_OF_RESIDENCY, OTHER |
identity_document_type (anyOf 2) | null | Alternative | |
kyc_status | string | Required within parent | The current KYC verification status of the profile Known values: APPROVED, REJECTED, PENDING_REVIEW, EXPIRED, EXPIRING_SOON, NOT_SUBMITTED, NOT_REQUESTED |
rejection_date | JSON | Required within parent | |
rejection_date (anyOf 1) | string | Alternative | The date and time when the KYC screening was rejected (null if not rejected or pending review for Veriff) Format: date-time |
rejection_date (anyOf 2) | null | Alternative | The date and time when the KYC screening was rejected (null if not rejected or pending review for Veriff) Format: date-time |
submission_date | JSON | Required within parent | |
submission_date (anyOf 1) | string | Alternative | The date and time when the KYC screening was submitted Format: date-time |
submission_date (anyOf 2) | null | Alternative | The date and time when the KYC screening was submitted Format: date-time |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | The date and time when the KYC screening was last updated Format: date-time |
updated_at (anyOf 2) | null | Alternative | The date and time when the KYC screening was last updated Format: date-time |
Submit external KYC — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Submit external KYC — 201 response body — data |
Referenced models: Submit external KYC — 201 response body — data
Submit external KYC — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp when screening was successfully received and processed (ISO 8601) Format: date-time |
request_id | string | Required within parent | Request identifier for this KYC submission |
Submit external KYC — request body — body data kyc document
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
document_name | string | Optional | Name of the document when type is 'other' Maximum length: 100 |
expiration_date | string | Optional | Expiry date of the document (YYYY-MM-DD) Format: date |
id_number | string | Required within parent | Document identification number Maximum length: 50 |
issuance_country | string | Required within parent | Country where the document was issued (ISO 3166‑1 alpha‑2) Maximum length: 2 Minimum length: 2 |
issuance_date | string | Optional | Date when the document was issued (YYYY-MM-DD) Format: date |
type | string | Required within parent | Type of KYC document (e.g., passport, driver's license) One of: passport, driving_license, government_id, other |