Skip to content

Deel: List Legal Entity Registration Documents

Deel documents.listLegalEntityRegistrationDocuments: arguments, response, policy and SDK examples.

← Documents operations · Get started

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.

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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.legal_entity_idstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 20
Maximum: 100
Minimum: 1
query.cursorstringOptionalMaximum length: 2048
Pattern: ^[A-Za-z0-9_-]+$
query.searchstringOptionalMaximum length: 255
query.statusarrayOptional
query.status[]stringEach itemOne of: REQUESTED, AWAITING_REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED
query.product_typearrayOptional
query.product_type[]stringEach itemOne of: EMBEDDED_PAYROLL, GLOBAL_PAYROLL, PEO
query.requirement_idarrayOptional
query.requirement_id[]stringEach itemFormat: uuid
query.only_archivedbooleanOptionalDefault: false

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List Legal Entity Registration Documents — 200 response body

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

1 more schema is linked from the tables above, on the schema pages.

List Legal Entity Registration Documents — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentDocuments for this page.
data[]ModelEach itemExpand Get Legal Entity Registration Document — 200 response body — data
has_morebooleanRequired within parentWhether another page of results is available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to pass as `cursor` for the next page. Null when there are no more pages.
next_cursor (anyOf 2)nullAlternativeCursor to pass as `cursor` for the next page. Null when there are no more pages.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of matching documents.
Minimum: 0
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get Legal Entity Registration Document — 200 response body — data

Get Legal Entity Registration Document — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeWhen the submission was archived.
Format: date-time
archived_at (anyOf 2)nullAlternativeWhen the submission was archived.
Format: date-time
archived_submissions_countJSONOptional
archived_submissions_count (anyOf 1)integerAlternativeHow many superseded revisions exist.
Minimum: 0
archived_submissions_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
childrenarrayOptionalSuperseded revisions of this submission, newest first.
children[]ModelEach itemExpand Get Legal Entity Registration Document — 200 response body — data children item
filesarrayOptionalFiles attached to this submission.
files[]ModelEach itemExpand Get Legal Entity Registration Document — 200 response body — data files item
idJSONRequired within parent
id (anyOf 1)stringAlternativePublic UUID of the submission. Null when nothing has been submitted for this requirement yet.
Format: uuid
id (anyOf 2)nullAlternativePublic UUID of the submission. Null when nothing has been submitted for this requirement yet.
Format: uuid
legal_entityJSONOptionalThe legal entity the document belongs to.
legal_entity (anyOf 1)ModelAlternativeExpand Get Legal Entity Registration Document — 200 response body — data legal entity The legal entity the document belongs to
legal_entity (anyOf 2)nullAlternative
parentJSONOptionalThe submission this one replaced, when it is a resubmission.
parent (anyOf 1)ModelAlternativeExpand Get Legal Entity Registration Document — 200 response body — data / parent / status: REQUESTED, AWAITING REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED
parent (anyOf 2)nullAlternative
rejection_reasonJSONOptional
rejection_reason (anyOf 1)stringAlternativeWhy the submission was rejected, when applicable.
rejection_reason (anyOf 2)nullAlternativeWhy the submission was rejected, when applicable.
requirementJSONOptionalThe document requirement this submission answers.
requirement (anyOf 1)ModelAlternativeExpand Get Legal Entity Registration Document — 200 response body — data requirement The document requirement this submission answers
requirement (anyOf 2)nullAlternative
reviewed_atJSONOptional
reviewed_at (anyOf 1)stringAlternativeWhen the document was reviewed.
Format: date-time
reviewed_at (anyOf 2)nullAlternativeWhen the document was reviewed.
Format: date-time
statusstringRequired within parentCurrent review status.
Known values: REQUESTED, AWAITING_REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED
submission_due_dateJSONOptional
submission_due_date (anyOf 1)stringAlternativeWhen the document is due.
Format: date-time
submission_due_date (anyOf 2)nullAlternativeWhen the document is due.
Format: date-time
submitted_atJSONOptional
submitted_at (anyOf 1)stringAlternativeWhen the document was submitted.
Format: date-time
submitted_at (anyOf 2)nullAlternativeWhen the document was submitted.
Format: date-time

Referenced models: Get Legal Entity Registration Document — 200 response body — data children item, Get Legal Entity Registration Document — 200 response body — data files item, Get Legal Entity Registration Document — 200 response body — data legal entity The legal entity the document belongs to, Get Legal Entity Registration Document — 200 response body — data / parent / status: REQUESTED, AWAITING REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED, Get Legal Entity Registration Document — 200 response body — data requirement The document requirement this submission answers

Get Legal Entity Registration Document — 200 response body — data children item
FieldTypePresenceDescription and constraints
$objectRoot
archived_atJSONOptional
archived_at (anyOf 1)stringAlternativeWhen the submission was archived.
Format: date-time
archived_at (anyOf 2)nullAlternativeWhen the submission was archived.
Format: date-time
filesarrayOptionalFiles attached to this submission.
files[]ModelEach itemExpand Get Legal Entity Registration Document — 200 response body — data files item
idJSONRequired within parent
id (anyOf 1)stringAlternativePublic UUID of the submission. Null when nothing has been submitted for this requirement yet.
Format: uuid
id (anyOf 2)nullAlternativePublic UUID of the submission. Null when nothing has been submitted for this requirement yet.
Format: uuid
rejection_reasonJSONOptional
rejection_reason (anyOf 1)stringAlternativeWhy the submission was rejected, when applicable.
rejection_reason (anyOf 2)nullAlternativeWhy the submission was rejected, when applicable.
reviewed_atJSONOptional
reviewed_at (anyOf 1)stringAlternativeWhen the document was reviewed.
Format: date-time
reviewed_at (anyOf 2)nullAlternativeWhen the document was reviewed.
Format: date-time
statusstringRequired within parentCurrent review status.
Known values: REQUESTED, AWAITING_REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED
submitted_atJSONOptional
submitted_at (anyOf 1)stringAlternativeWhen the document was submitted.
Format: date-time
submitted_at (anyOf 2)nullAlternativeWhen the document was submitted.
Format: date-time

Referenced models: Get Legal Entity Registration Document — 200 response body — data files item

Get Legal Entity Registration Document — 200 response body — data files item
FieldTypePresenceDescription and constraints
$objectRoot
content_typeJSONOptional
content_type (anyOf 1)stringAlternativeMIME type of the file.
content_type (anyOf 2)nullAlternativeMIME type of the file.
idstringRequired within parentPublic UUID of the file.
Format: uuid
original_filenamestringRequired within parentFilename as uploaded.
uploaded_atJSONOptional
uploaded_at (anyOf 1)stringAlternativeWhen the file was uploaded.
Format: date-time
uploaded_at (anyOf 2)nullAlternativeWhen the file was uploaded.
Format: date-time
Get Legal Entity Registration Document — 200 response body — data legal entity The legal entity the document belongs to
FieldTypePresenceDescription and constraints
$objectRootThe legal entity the document belongs to.
countryJSONOptional
country (anyOf 1)stringAlternativeISO country code of the entity address.
country (anyOf 2)nullAlternativeISO country code of the entity address.
idstringOptionalPublic UUID of the legal entity.
Format: uuid
nameJSONOptional
name (anyOf 1)stringAlternativeLegal entity name.
name (anyOf 2)nullAlternativeLegal entity name.
Get Legal Entity Registration Document — 200 response body — data / parent / status: REQUESTED, AWAITING REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED
FieldTypePresenceDescription and constraints
$objectRootThe submission this one replaced, when it is a resubmission.
idstringOptionalPublic UUID of the superseded submission.
Format: uuid
statusstringOptionalStatus of the superseded submission.
Known values: REQUESTED, AWAITING_REVIEW, REJECTED, APPROVED, UNSOLICITED, COMPLETED

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

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.