Skip to content

Deel: Get registration tax identifier fields for a country

Deel legalEntities.getCountryFieldsForAlegalEntity: arguments, response, policy and SDK examples.

← Legal entities operations · Get started

Operation deel.legalentities_getcountryfieldsforalegalentity_v2026_09_11

Provider route: GET /legal-entities/country-fields/{country_code}. 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["legalEntities"]["getCountryFieldsForAlegalEntity"]>[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.getCountryFieldsForAlegalEntity(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.get_country_fields_for_alegal_entity(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.country_codestringRequired within parentPattern: ^[A-Za-z]{2}$

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get registration tax identifier fields for a country — 200 response body

Referenced models: Get registration tax identifier fields for a country — 200 response body

Get registration tax identifier fields for a country — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Get registration tax identifier fields for a country — 200 response body — data

Referenced models: Get registration tax identifier fields for a country — 200 response body — data

Get registration tax identifier fields for a country — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
country_codestringOptionalISO 3166-1 alpha-2 country code, uppercased.
fieldsarrayOptionalEmpty when the country is recognized but has no configured identifier fields.
fields[]ModelEach itemExpand Get registration tax identifier fields for a country — 200 response body — data fields item

Referenced models: Get registration tax identifier fields for a country — 200 response body — data fields item

Get registration tax identifier fields for a country — 200 response body — data fields item
FieldTypePresenceDescription and constraints
$objectRoot
kindstringOptionalWhether this field is a registration or tax identifier.
Known values: registration_id, tax_id
namestringOptionalHuman-readable name of the identifier field.
requirementstringOptional`mandatory` — must be collected and submitted. `optional` — may be submitted but is not required. `bypass` — not required; clients should omit it unless they have a value, since if provided it may still be validated.
Known values: mandatory, optional, bypass
validation_regexJSONOptional
validation_regex (anyOf 1)stringAlternativeRegex the submitted value must match. `null` when the field has no format restriction.
validation_regex (anyOf 2)nullAlternativeRegex the submitted value must match. `null` when the field has no format restriction.

SDK function policy ID: deel.legalentities_getcountryfieldsforalegalentity_v2026_09_11. Catalog operation: legalentities_getcountryfieldsforalegalentity_v2026_09_11. 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-09-11"}

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.