Deel: Submit external KYC

← screenings operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.screenings_submitexternalkyc_v2026_01_01

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

Call through Alter

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"]["submitExternalKyc"]>[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.submitExternalKyc(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.submit_external_kyc(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Optional
body.data	object	Required within parent
body.data.back	object	Optional	Back side file of the KYC document. Required when kyc_document.type equals to either ‘driving_license’ or ‘government_id’. Not needed when equals to ‘passport’. Optional when type is ‘other’ Additional keys: not allowed
body.data.back.filename	string	Required within parent	Minimum length: 1
body.data.back.content_type	string	Required within parent	Minimum length: 1
body.data.back.content_base64	string	Required within parent
body.data.date_of_birth	string	Required within parent	Worker’s date of birth (YYYY-MM-DD) Format: date
body.data.first_name	string	Required within parent	Worker’s first name Maximum length: 100
body.data.front	object	Required within parent	Front side file of the KYC document Additional keys: not allowed
body.data.front.filename	string	Required within parent	Minimum length: 1
body.data.front.content_type	string	Required within parent	Minimum length: 1
body.data.front.content_base64	string	Required within parent
body.data.kyc_document	Model	Required within parent	Expand Submit external KYC — request body — body data kyc document
body.data.last_name	string	Required within parent	Worker’s last name Maximum length: 100
body.data.middle_name	string or null	Optional	Worker’s middle name (if available) Maximum length: 100
body.data.screening_status	string	Required within parent	The result of the screening process One of: approved, rejected
body.data.screening_type	string	Required within parent	Tells your API whether the identity verification check should be performed automatically (“live”) or via human review (“manual”) One of: live, manual
body.data.selfie_with_id	object	Required within parent	Selfie file for identity verification Additional keys: not allowed
body.data.selfie_with_id.filename	string	Required within parent	Minimum length: 1
body.data.selfie_with_id.content_type	string	Required within parent	Minimum length: 1
body.data.selfie_with_id.content_base64	string	Required within parent

Referenced models: Submit external KYC — request body — body data kyc document

Response

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

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Submit external KYC — 201 response body

Referenced models: Submit external KYC — 201 response body

Policy, approvals and errors

SDK function policy ID: deel.screenings_submitexternalkyc_v2026_01_01. Catalog operation: screenings_submitexternalkyc_v2026_01_01. 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: ["worker:write"]

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

Official provider source