Deel: Create manual verification screening

← screenings operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.screenings_createmanualverification

Provider route: POST /screenings/manual-verification. 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"]["createManualVerification"]>[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.createManualVerification(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.create_manual_verification(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.additional	object	Optional	An additional document Additional keys: not allowed
body.additional.filename	string	Required within parent	Minimum length: 1
body.additional.content_type	string	Required within parent	Minimum length: 1
body.additional.content_base64	string	Required within parent
body.back	object	Optional	The back side of the document Additional keys: not allowed
body.back.filename	string	Required within parent	Minimum length: 1
body.back.content_type	string	Required within parent	Minimum length: 1
body.back.content_base64	string	Required within parent
body.document_country	string	Optional	The issuing country code of the document to be verified (ISO 3166-1 alpha-2) Maximum length: 2 Minimum length: 2
body.document_type	string	Required within parent	The type of document to be verified One of: PASSPORT, DRIVING_LICENSE, GOVERNMENT_ID, OTHER
body.front	object	Required within parent	The front side of the document Additional keys: not allowed
body.front.filename	string	Required within parent	Minimum length: 1
body.front.content_type	string	Required within parent	Minimum length: 1
body.front.content_base64	string	Required within parent
body.operation_type	string	Required within parent	The type of KYC operation to perform One of: IDENTITY_RESUBMISSION_KYC, IDENTITY_VERIFICATION_KYC, NAME_CHANGE_KYC
body.proof_of_residence	object	Optional	A proof of residence document Additional keys: not allowed
body.proof_of_residence.filename	string	Required within parent	Minimum length: 1
body.proof_of_residence.content_type	string	Required within parent	Minimum length: 1
body.proof_of_residence.content_base64	string	Required within parent
body.selfie_with_id	object	Required within parent	A selfie of the user holding the ID document Additional keys: not allowed
body.selfie_with_id.filename	string	Required within parent	Minimum length: 1
body.selfie_with_id.content_type	string	Required within parent	Minimum length: 1
body.selfie_with_id.content_base64	string	Required within parent
body.translation_required	boolean	Required within parent	Indicates whether the document requires translation

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 Create manual verification screening — 201 response body

Referenced models: Create manual verification screening — 201 response body

Policy, approvals and errors

SDK function policy ID: deel.screenings_createmanualverification. Catalog operation: screenings_createmanualverification. 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