Skip to main content
POST
/
address
/
validate
curl --request POST \
  --url https://rest.taxes.provider.com/api/v1/address/validate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "line1": "1000 main",
    "line2": "",
    "line3": "",
    "city": "Irvine",
    "state": "CA",
    "country": "US",
    "postalCode": "92615"
  }
}
'
{
  "status": "VALID"
}

Documentation Index

Fetch the complete documentation index at: https://spidocs.chargebee.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The json of all the parameters specified in authentication configuration of tax app will be sent by Chargebee.

Headers

​
merchant_id
string

Merchant's domain name will be sent by Chargebee

​
trace_id
string

Unique id of the request will be sent by Chargebee

Body

application/json

The verification request containing the address. The following fields are mandatory -

  • line1
  • city
  • postalCode
  • state
  • country
​
address
object

Represents the address used for validation.

Example:
{
  "country": "country",
  "city": "city",
  "postalCode": "postalCode",
  "state": "state",
  "line3": "line3",
  "line2": "line2",
  "line1": "line1"
}

Response

Address is validated successfully

​
status
enum<string>
required

The validation status of an address.

Available options:
VALID,
INVALID