List a customer's legal identifiers
The buyer's typed identifiers, labelled by the register that issued them rather than by the seller's vocabulary.
path Parameters
customerIdHeaders
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List a customer's legal identifiers › Responses
OK
Add or update one of a customer's legal identifiers
Same pattern and check-digit gate as the organization's own. An unrecognised key is refused; it is never stored as a generic tax registration.
path Parameters
customerIdHeaders
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Add or update one of a customer's legal identifiers › Request Body
kindvaluecountryvalid_fromvalid_toAdd or update one of a customer's legal identifiers › Responses
OK
Dry-run one of a customer's identifier values
The buyer analogue of the organization dry run, labelled by the register that issues the kind rather than by the seller's vocabulary. Writes nothing.
path Parameters
customerIdHeaders
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Dry-run one of a customer's identifier values › Request Body
kindvaluecountryvalid_fromvalid_toDry-run one of a customer's identifier values › Responses
OK
Delete one of a customer's legal identifiers
path Parameters
customerIdidHeaders
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Delete one of a customer's legal identifiers › Responses
No Content
Legal-identity readiness for the governing jurisdiction
For each surface the law reaches — invoice, credit note, quote, business e-mail, portal imprint — which identifiers and register facts the governing jurisdiction requires, which are on file, and which are required only under a condition that cannot be evaluated yet. Every item carries the statutory source it comes from.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Legal-identity readiness for the governing jurisdiction › Responses
OK
List the organization's legal identifiers
Returns the typed identifiers the organization holds (VAT id, national tax number, commercial-register number, SIREN, KVK, CHE-UID, org-nr, Peppol participant id …) together with the kinds its governing jurisdiction makes available and requires. The kind list is server-side because which identifiers a party may hold is a function of the governing jurisdiction and the date.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List the organization's legal identifiers › Responses
OK
Add or update one of the organization's legal identifiers
Writes one identifier. The value is normalized and gated on the kind's pattern and, where a dossier documents one, its check digit; an unknown kind is refused rather than stored as a generic tax number. Re-posting a value that differs only in punctuation updates how it prints and does not create a second row.
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Add or update one of the organization's legal identifiers › Request Body
kindvaluecountryvalid_fromvalid_toAdd or update one of the organization's legal identifiers › Responses
OK
Dry-run one identifier value against its kind
Runs the SAME pattern and check-digit gate the write path runs, and writes nothing. Answers whether the value is shaped like the kind, whether a check digit could be run at all, and whether it passed — three states a single boolean cannot carry. An unknown kind is still a 400; a wrong VALUE is a 200 with ok=false, because that is an answer rather than an error.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Dry-run one identifier value against its kind › Request Body
kindvaluecountryvalid_fromvalid_toDry-run one identifier value against its kind › Responses
OK
Delete one of the organization's legal identifiers
Removes a mistyped identifier. A number that has LAPSED is not deleted: it is given an end date, so a document issued while it was live can still state it.
path Parameters
idHeaders
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Delete one of the organization's legal identifiers › Responses
No Content
Get the organization's register facts
Legal form, seat region, registered office, share capital, liquidation status and the ordered list of representatives — the statements business-letter law requires beside the register number, none of which is an identifier.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Get the organization's register facts › Responses
OK
Update the organization's register facts
Partial update. A representatives array, when present, REPLACES the whole list: the statutes that require directors to be named are all-or-nothing.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Update the organization's register facts › Request Body
clear_registered_office_addressclear_share_capitalin_liquidationlegal_formseat_regionshare_capital_currencyshare_capital_minorUpdate the organization's register facts › Responses
OK