Skip to content

Deel: Get worker's KYC details

Deel screenings.getKycdetails: arguments, response, policy and SDK examples.

← Screenings operations · Get started

Operation deel.screenings_getkycdetails

Provider route: GET /screenings/kyc/details. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["screenings"]["getKycdetails"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.screenings.getKycdetails(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.screenings.get_kycdetails(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.worker_profile_idstringOptionalFormat: uuid
query.contract_idstringOptionalMaximum length: 100
query.profile_idstringOptionalFormat: uuid

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get worker’s KYC details — 200 response body

Referenced models: Get worker’s KYC details — 200 response body

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

SDK function policy ID: deel.screenings_getkycdetails. Catalog operation: screenings_getkycdetails. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["screenings:read"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

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.