Skip to content

Deel: Screenings schemas

15 Deel schemas with complete fields and constraints.

← Screenings operations · All schemas

Create Veriff session — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create Veriff session — 201 response body — data

Referenced models: Create Veriff session — 201 response body — data

Create Veriff session — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
urlstringRequired within parentThe URL of the Veriff session

Create Veriff session — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
operation_typestringRequired within parentThe type of KYC operation to perform
One of: IDENTITY_RESUBMISSION_KYC, IDENTITY_VERIFICATION_KYC, NAME_CHANGE_KYC, EMAIL_CHANGE_KYC
user_inputModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRootInput data for the name change KYC operation
first_namestringRequired within parentThe desired first name of the user
last_namestringRequired within parentThe desired last name of the user
middle_namestring or nullOptionalThe desired middle name of the user

Create manual verification screening — 201 response body

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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp when screening was successfully received and processed (ISO 8601)
Format: date-time
request_idstringRequired within parentUnique request identifier

Get entity screening details — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
detailed_resultsModelRequired within parentExpand Get entity screening details — 200 response body — detailed results
Details of checks performed for this screening.
entity_idstringRequired within parentUUID of the entity.
entity_typestringRequired within parentThe type of entity being screened.
Known values: profile, hris_profile, legal_entity
resultstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRootDetails of checks performed for this screening.
adverse_mediastringOptionalThe result of the adverse media check.
Known values: PASS, FAIL
pepstringOptionalThe result of the PEP (Politically Exposed Person) check.
Known values: PASS, FAIL
sanctionsstringOptionalThe result of the sanctions check.
Known values: PASS, FAIL

Get verification method — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get verification method — 200 response body — data

Referenced models: Get verification method — 200 response body — data

Get verification method — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
verification_methodstringRequired within parentThe supported method for KYC

Get worker's KYC details — 200 response body

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

FieldTypePresenceDescription and constraints
$objectRoot
approval_dateJSONRequired within parent
approval_date (anyOf 1)stringAlternativeThe date and time when the KYC screening was approved (null if not approved)
Format: date-time
approval_date (anyOf 2)nullAlternativeThe date and time when the KYC screening was approved (null if not approved)
Format: date-time
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeThe date and time when the KYC screening was created
Format: date-time
created_at (anyOf 2)nullAlternativeThe date and time when the KYC screening was created
Format: date-time
document_extracted_first_nameJSONOptional
document_extracted_first_name (anyOf 1)stringAlternativeThe first name extracted from the submitted document
document_extracted_first_name (anyOf 2)nullAlternativeThe first name extracted from the submitted document
document_extracted_last_nameJSONOptional
document_extracted_last_name (anyOf 1)stringAlternativeThe last name extracted from the submitted document
document_extracted_last_name (anyOf 2)nullAlternativeThe last name extracted from the submitted document
document_extracted_middle_nameJSONRequired within parent
document_extracted_middle_name (anyOf 1)stringAlternativeThe middle name extracted from the submitted document
document_extracted_middle_name (anyOf 2)nullAlternativeThe middle name extracted from the submitted document
expiration_dateJSONRequired within parent
expiration_date (anyOf 1)stringAlternativeThe date and time when the KYC screening expires (null if no expiry)
Format: date-time
expiration_date (anyOf 2)nullAlternativeThe date and time when the KYC screening expires (null if no expiry)
Format: date-time
identity_document_nameJSONOptional
identity_document_name (anyOf 1)stringAlternativeThe name of the identity document used for verification (in case of other document type)
identity_document_name (anyOf 2)nullAlternativeThe name of the identity document used for verification (in case of other document type)
identity_document_numberJSONOptional
identity_document_number (anyOf 1)stringAlternativeNumber of the submitted document
identity_document_number (anyOf 2)nullAlternativeNumber of the submitted document
identity_document_typeJSONRequired within parentThe type of identity document used for verification
identity_document_type (anyOf 1)stringAlternativeThe 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)nullAlternative
kyc_statusstringRequired within parentThe current KYC verification status of the profile
Known values: APPROVED, REJECTED, PENDING_REVIEW, EXPIRED, EXPIRING_SOON, NOT_SUBMITTED, NOT_REQUESTED
rejection_dateJSONRequired within parent
rejection_date (anyOf 1)stringAlternativeThe 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)nullAlternativeThe date and time when the KYC screening was rejected (null if not rejected or pending review for Veriff)
Format: date-time
submission_dateJSONRequired within parent
submission_date (anyOf 1)stringAlternativeThe date and time when the KYC screening was submitted
Format: date-time
submission_date (anyOf 2)nullAlternativeThe date and time when the KYC screening was submitted
Format: date-time
updated_atJSONRequired within parent
updated_at (anyOf 1)stringAlternativeThe date and time when the KYC screening was last updated
Format: date-time
updated_at (anyOf 2)nullAlternativeThe date and time when the KYC screening was last updated
Format: date-time

Submit external KYC — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Submit external KYC — 201 response body — data

Referenced models: Submit external KYC — 201 response body — data

Submit external KYC — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp when screening was successfully received and processed (ISO 8601)
Format: date-time
request_idstringRequired within parentRequest identifier for this KYC submission

Submit external KYC — request body — body data kyc document

FieldTypePresenceDescription and constraints
$objectRoot
document_namestringOptionalName of the document when type is 'other'
Maximum length: 100
expiration_datestringOptionalExpiry date of the document (YYYY-MM-DD)
Format: date
id_numberstringRequired within parentDocument identification number
Maximum length: 50
issuance_countrystringRequired within parentCountry where the document was issued (ISO 3166‑1 alpha‑2)
Maximum length: 2
Minimum length: 2
issuance_datestringOptionalDate when the document was issued (YYYY-MM-DD)
Format: date
typestringRequired within parentType of KYC document (e.g., passport, driver's license)
One of: passport, driving_license, government_id, other

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.