Deel: Upload a KYB document for a legal entity

← legal_entities operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.legalentities_uploadlegalentitykybdocument_v2026_10_02

Provider route: POST /legal-entities/{legal_entity_id}/kyb/documents. 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["legalEntities"]["uploadLegalEntityKybDocument"]>[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.legalEntities.uploadLegalEntityKybDocument(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.legal_entities.upload_legal_entity_kyb_document(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.legal_entity_id	string	Required within parent	Format: uuid
headers	object	Required within parent	Additional keys: not allowed
headers.X-Beta	string	Required within parent	Default: true One of: true
body	object	Optional
body.data	object	Required within parent
body.data.document_type	string	Required within parent	What the file is. Company documents: `ARTICLES_OF_INCORPORATION`, `COMPANY_BANK_STATEMENT`, `CERTIFICATE_OF_GOOD_STANDING`, `ULTIMATE_BENEFICIAL_OWNER_FORM`, `PROOF_OF_AUTHORITY` (a power of attorney, a board resolution or minutes, or another document evidencing authority). Person documents, one per side: `IDENTITY_DOCUMENT_FRONT`, `IDENTITY_DOCUMENT_BACK`, `SELFIE`. A list of directors is not yet accepted by the verification service over the API. One of: ARTICLES_OF_INCORPORATION, COMPANY_BANK_STATEMENT, CERTIFICATE_OF_GOOD_STANDING, ULTIMATE_BENEFICIAL_OWNER_FORM, PROOF_OF_AUTHORITY, IDENTITY_DOCUMENT_FRONT, IDENTITY_DOCUMENT_BACK, SELFIE
body.data.file	object	Required within parent	The document. Company documents accept PDF, JPEG and PNG. Identity documents and selfies accept JPEG and PNG only. Additional keys: not allowed
body.data.file.filename	string	Required within parent	Minimum length: 1
body.data.file.content_type	string	Required within parent	Minimum length: 1
body.data.file.content_base64	string	Required within parent

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 Upload a KYB document for a legal entity — 201 response body

Referenced models: Upload a KYB document for a legal entity — 201 response body

Policy, approvals and errors

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

Pinned headers: {"X-Version": "2026-10-02"}

Official provider source