curl -X GET "https://transaction-tax.api.in.commenda.io/api/v1/address-requirements?country=US" \
-H "Authorization: Bearer <token>"
curl -X GET "https://transaction-tax.api.in.commenda.io/api/v1/address-requirements?country=GB" \
-H "Authorization: Bearer <token>"
curl -X GET "https://transaction-tax.api.in.commenda.io/api/v1/address-requirements?country=DE" \
-H "Authorization: Bearer <token>"
{
"data": {
"country_code": "US",
"address_line_1": "REQUIRED",
"address_line_2": "OPTIONAL",
"address_line_3": "IGNORED",
"city": "REQUIRED",
"state": "REQUIRED",
"postal_code": "REQUIRED",
"postal_code_regex": "^\\d{5}(-\\d{4})?$",
"valid_state_codes": [
"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA",
"HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD",
"MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ",
"NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC",
"SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY",
"DC"
]
},
"message": "Successfully retrieved address requirements."
}
{
"data": {
"country_code": "GB",
"address_line_1": "REQUIRED",
"address_line_2": "OPTIONAL",
"address_line_3": "IGNORED",
"city": "REQUIRED",
"state": "OPTIONAL",
"postal_code": "REQUIRED",
"postal_code_regex": "^[A-Za-z]{1,2}\\d[A-Za-z\\d]? ?\\d[A-Za-z]{2}$"
},
"message": "Successfully retrieved address requirements."
}
{
"data": {
"country_code": "DE",
"address_line_1": "REQUIRED",
"address_line_2": "OPTIONAL",
"address_line_3": "IGNORED",
"city": "REQUIRED",
"state": "OPTIONAL",
"postal_code": "REQUIRED",
"postal_code_regex": "^\\d{5}$"
},
"message": "Successfully retrieved address requirements."
}
{
"type": "INVALID_REQUEST_BODY",
"title": "Invalid request body.",
"detail": {
"description": "country query parameter is required"
},
"status": 400
}
{
"type": "RESOURCE_NOT_FOUND",
"sub_type": "ADDRESS_REQUIREMENTS_NOT_FOUND",
"title": "Address requirements not found.",
"detail": {
"description": "No address requirements found for country: HM"
},
"status": 404
}
Address Requirements
Get address requirements
Returns the minimum address field requirements for a given country. Use this to determine which address fields are required, optional, or ignored when submitting addresses for tax calculations and transactions.
GET
/
address-requirements
curl -X GET "https://transaction-tax.api.in.commenda.io/api/v1/address-requirements?country=US" \
-H "Authorization: Bearer <token>"
curl -X GET "https://transaction-tax.api.in.commenda.io/api/v1/address-requirements?country=GB" \
-H "Authorization: Bearer <token>"
curl -X GET "https://transaction-tax.api.in.commenda.io/api/v1/address-requirements?country=DE" \
-H "Authorization: Bearer <token>"
{
"data": {
"country_code": "US",
"address_line_1": "REQUIRED",
"address_line_2": "OPTIONAL",
"address_line_3": "IGNORED",
"city": "REQUIRED",
"state": "REQUIRED",
"postal_code": "REQUIRED",
"postal_code_regex": "^\\d{5}(-\\d{4})?$",
"valid_state_codes": [
"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA",
"HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD",
"MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ",
"NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC",
"SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY",
"DC"
]
},
"message": "Successfully retrieved address requirements."
}
{
"data": {
"country_code": "GB",
"address_line_1": "REQUIRED",
"address_line_2": "OPTIONAL",
"address_line_3": "IGNORED",
"city": "REQUIRED",
"state": "OPTIONAL",
"postal_code": "REQUIRED",
"postal_code_regex": "^[A-Za-z]{1,2}\\d[A-Za-z\\d]? ?\\d[A-Za-z]{2}$"
},
"message": "Successfully retrieved address requirements."
}
{
"data": {
"country_code": "DE",
"address_line_1": "REQUIRED",
"address_line_2": "OPTIONAL",
"address_line_3": "IGNORED",
"city": "REQUIRED",
"state": "OPTIONAL",
"postal_code": "REQUIRED",
"postal_code_regex": "^\\d{5}$"
},
"message": "Successfully retrieved address requirements."
}
{
"type": "INVALID_REQUEST_BODY",
"title": "Invalid request body.",
"detail": {
"description": "country query parameter is required"
},
"status": 400
}
{
"type": "RESOURCE_NOT_FOUND",
"sub_type": "ADDRESS_REQUIREMENTS_NOT_FOUND",
"title": "Address requirements not found.",
"detail": {
"description": "No address requirements found for country: HM"
},
"status": 404
}
curl -X GET "https://transaction-tax.api.in.commenda.io/api/v1/address-requirements?country=US" \
-H "Authorization: Bearer <token>"
curl -X GET "https://transaction-tax.api.in.commenda.io/api/v1/address-requirements?country=GB" \
-H "Authorization: Bearer <token>"
curl -X GET "https://transaction-tax.api.in.commenda.io/api/v1/address-requirements?country=DE" \
-H "Authorization: Bearer <token>"
{
"data": {
"country_code": "US",
"address_line_1": "REQUIRED",
"address_line_2": "OPTIONAL",
"address_line_3": "IGNORED",
"city": "REQUIRED",
"state": "REQUIRED",
"postal_code": "REQUIRED",
"postal_code_regex": "^\\d{5}(-\\d{4})?$",
"valid_state_codes": [
"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA",
"HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD",
"MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ",
"NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC",
"SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY",
"DC"
]
},
"message": "Successfully retrieved address requirements."
}
{
"data": {
"country_code": "GB",
"address_line_1": "REQUIRED",
"address_line_2": "OPTIONAL",
"address_line_3": "IGNORED",
"city": "REQUIRED",
"state": "OPTIONAL",
"postal_code": "REQUIRED",
"postal_code_regex": "^[A-Za-z]{1,2}\\d[A-Za-z\\d]? ?\\d[A-Za-z]{2}$"
},
"message": "Successfully retrieved address requirements."
}
{
"data": {
"country_code": "DE",
"address_line_1": "REQUIRED",
"address_line_2": "OPTIONAL",
"address_line_3": "IGNORED",
"city": "REQUIRED",
"state": "OPTIONAL",
"postal_code": "REQUIRED",
"postal_code_regex": "^\\d{5}$"
},
"message": "Successfully retrieved address requirements."
}
{
"type": "INVALID_REQUEST_BODY",
"title": "Invalid request body.",
"detail": {
"description": "country query parameter is required"
},
"status": 400
}
{
"type": "RESOURCE_NOT_FOUND",
"sub_type": "ADDRESS_REQUIREMENTS_NOT_FOUND",
"title": "Address requirements not found.",
"detail": {
"description": "No address requirements found for country: HM"
},
"status": 404
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
A valid 2-letter ISO 3166-1 alpha-2 country code (e.g., US, CA, GB).
Example:
"US"
Was this page helpful?
⌘I