Deel: List Legal Entity Registration Documents

← documents operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.documents_listlegalentityregistrationdocuments_v2026_08_17

Provider route: GET /legal-entities/{legal_entity_id}/registration-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["documents"]["listLegalEntityRegistrationDocuments"]>[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.documents.listLegalEntityRegistrationDocuments(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.documents.list_legal_entity_registration_documents(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
query	object	Optional	Additional keys: not allowed
query.limit	integer	Optional	Default: 20 Maximum: 100 Minimum: 1
query.cursor	string	Optional	Maximum length: 2048 Pattern: ^[A-Za-z0-9_-]+$
query.search	string	Optional	Maximum length: 255
query.status	array	Optional
query.status[]	string	Each item	One of: REQUESTED, AWAITING_REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED
query.product_type	array	Optional
query.product_type[]	string	Each item	One of: EMBEDDED_PAYROLL, GLOBAL_PAYROLL, PEO
query.requirement_id	array	Optional
query.requirement_id[]	string	Each item	Format: uuid
query.only_archived	boolean	Optional	Default: false

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 List Legal Entity Registration Documents — 200 response body

Referenced models: List Legal Entity Registration Documents — 200 response body

Policy, approvals and errors

SDK function policy ID: deel.documents_listlegalentityregistrationdocuments_v2026_08_17. Catalog operation: documents_listlegalentityregistrationdocuments_v2026_08_17. 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:read"]

Pinned headers: {"X-Version": "2026-08-17"}

Official provider source