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.
Call through Alter
Section titled “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"]["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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.country_code | string | Required within parent | Pattern: ^[A-Za-z]{2}$ |
Response
Section titled “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 Get registration tax identifier fields for a country — 200 response body |
Referenced models: Get registration tax identifier fields for a country — 200 response body
Schemas
Section titled “Schemas”Get registration tax identifier fields for a country — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country_code | string | Optional | ISO 3166-1 alpha-2 country code, uppercased. |
fields | array | Optional | Empty when the country is recognized but has no configured identifier fields. |
fields[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
kind | string | Optional | Whether this field is a registration or tax identifier. Known values: registration_id, tax_id |
name | string | Optional | Human-readable name of the identifier field. |
requirement | string | Optional | `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_regex | JSON | Optional | |
validation_regex (anyOf 1) | string | Alternative | Regex the submitted value must match. `null` when the field has no format restriction. |
validation_regex (anyOf 2) | null | Alternative | Regex the submitted value must match. `null` when the field has no format restriction. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}