Kanorio

API reference

Tax identities

Customer API: GET /tax-identities, PUT /tax-identities, DELETE /tax-identities/{id}

Base URL https://{site}/api/v1/customerErrorsPagination

List the customer's tax IDs

GET/tax-identities
beta

One per country and type, with the verification status against the public registry where one exists.

Response 200

  • taxIdentitiesobject[]required
  • taxIdentities[].idstringrequired
  • taxIdentities[].countrystringrequired
  • taxIdentities[].typestringrequired
  • taxIdentities[].valuestringrequired

    As entered.

  • taxIdentities[].normalizedstringrequired
  • taxIdentities[].status"PENDING" | "VALID_FORMAT" | "VERIFIED" | "NOT_FOUND" | "UNAVAILABLE" | "INVALID_FORMAT"required

    Verification against the public registry; informational only.

  • taxIdentities[].namestring | nullrequired
  • taxIdentities[].addressstring | nullrequired
  • taxIdentities[].registryNamestring | nullrequired

    Name recorded by the registry when VERIFIED.

  • taxIdentities[].registryStatusstring | nullrequired
  • taxIdentities[].attributionobject | nullrequired

    Open-data attribution to show next to registry data.

  • taxIdentities[].attribution.providerstring
  • taxIdentities[].attribution.providerEnstring
  • taxIdentities[].attribution.dataDatestring
curlTypeScript
curl -X GET "https://{site}/api/v1/customer/tax-identities" \
  -H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN"

Add or update a tax ID

PUT/tax-identities
beta

Keyed by country and type (type defaults to the country's first registered type). Format and checksum follow the shared business-registry rules; a changed number is re-verified asynchronously. Verification results are informational and never block checkout.

Request body

  • countrystringrequired

    ISO 3166-1 alpha-2.

  • typestring | null

    Tax ID type (for example tw_vat, jp_trn, eu_vat); defaults to the country's first registered type.

  • valuestringrequired
  • namestring | null

    Registered name for invoices.

  • addressstring | null

    Registered address for invoices.

Response 200

  • taxIdentityobjectrequired
  • taxIdentity.idstringrequired
  • taxIdentity.countrystringrequired
  • taxIdentity.typestringrequired
  • taxIdentity.valuestringrequired

    As entered.

  • taxIdentity.normalizedstringrequired
  • taxIdentity.status"PENDING" | "VALID_FORMAT" | "VERIFIED" | "NOT_FOUND" | "UNAVAILABLE" | "INVALID_FORMAT"required

    Verification against the public registry; informational only.

  • taxIdentity.namestring | nullrequired
  • taxIdentity.addressstring | nullrequired
  • taxIdentity.registryNamestring | nullrequired

    Name recorded by the registry when VERIFIED.

  • taxIdentity.registryStatusstring | nullrequired
  • taxIdentity.attributionobject | nullrequired

    Open-data attribution to show next to registry data.

  • taxIdentity.attribution.providerstring
  • taxIdentity.attribution.providerEnstring
  • taxIdentity.attribution.dataDatestring
  • createdboolean

Errors

  • VALIDATION 400
  • INVALID_TAX_ID 400
  • UNSUPPORTED_COUNTRY 400
curlTypeScript
curl -X PUT "https://{site}/api/v1/customer/tax-identities" \
  -H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Remove a tax ID

DELETE/tax-identities/{id}
beta

Parameters

  • idstring · pathrequired

Errors

  • NOT_FOUND 404
curlTypeScript
curl -X DELETE "https://{site}/api/v1/customer/tax-identities/{id}" \
  -H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN"