KintsugiKintsugi

Upsert a customer tax registration by tax id

POST/customers/{customer_id}/tax-registrations

Create or update a tax registration. Send countryCode and taxType together to validate taxId against that pair; omit both to derive from taxId and the customer's country. Always 200. 400 if taxId is invalid, mismatched, or only one field is sent. 404 if the customer doesn't exist.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Path parameters

customer_idstringRequired

The unique identifier of the customer.

Body

taxIdstringRequired

The tax registration number. When countryCode and taxType are both omitted, they are derived from this value together with the customer's own country.

countryCodestring

Country the registration is valid in, ISO 3166-1 alpha-2. Send this together with taxType to validate taxId against an explicit pair instead of deriving one.

taxTypePublicCustomerTaxTypeEnum

Kind of tax the registration is for. Send this together with countryCode.

Available options:gsthstgst_hstqstpstrstvatunknown

Response

idstringRequired

Kintsugi's unique identifier for the registration.

countryCodestringRequired

Country the registration is valid in, ISO 3166-1 alpha-2.

taxTypePublicCustomerTaxTypeEnumRequired

Kind of tax the registration is for.

Available options:gsthstgst_hstqstpstrstvatunknown
taxIdstringRequired

The tax registration number itself.

isValidbooleanRequired

Whether the tax id passed validation for its country and type. Derived by Kintsugi; not accepted on write.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

409

The request conflicts with existing state.

422

The request failed validation.

cURL
POST /customers/{customer_id}/tax-registrations
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
{
"taxId": "123456789RT0001",
"countryCode": "CA",
"taxType": "gst_hst"
}
Example request
https://api.trykintsugi.com/customers/{customer_id}/tax-registrations
Response
{
"id": "ctax_2mNpQr7Ls8f3k",
"countryCode": "CA",
"taxType": "gst_hst",
"taxId": "123456789RT0001",
"isValid": false
}
Upsert a customer tax registration by tax id (2026-07-21) | Kintsugi API Reference