Validate Tax Fields

curl --request POST \
  --url https://api.cadanapay.com/v1/tax/fields/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "countryCode": "MX",
  "taxFields": {
    "riskCategory": "I",
    "addressState": "JAL"
  }
}
'

{
  "valid": true,
  "rulesetVersion": "v2.1.0"
}

{
  "code": "invalid_request_body",
  "message": "The request body provided is not valid",
  "params": {
    "field": "Value is invalid."
  }
}

POST

tax

fields

validate

curl --request POST \
  --url https://api.cadanapay.com/v1/tax/fields/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "countryCode": "MX",
  "taxFields": {
    "riskCategory": "I",
    "addressState": "JAL"
  }
}
'

{
  "valid": true,
  "rulesetVersion": "v2.1.0"
}

{
  "code": "invalid_request_body",
  "message": "The request body provided is not valid",
  "params": {
    "field": "Value is invalid."
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey

string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Body

application/json

countryCode

string

required

taxFields

object

required

The tax field values to validate.

version

string

Validate against a pinned ruleset version. Omit for the current ruleset.

Example:

"v2.1.0"

Response

Validation result

valid

boolean

errors

string[]

warnings

string[]

rulesetVersion

string

The pinned version the fields were validated against. Returned only when the request pinned a version.

Overview

Payments API

Wallets API

Workforce API

Tax API

Statutory Compliance API

Authorizations

Headers

Body

Response