Address

The details of the address associated with the TRN information.

addressLine1

The first line of the address.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 180.

Pattern: ^(?!\s*$)[\s\S]+$

Required: Yes

city

The city that the address is in.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^(?!\s*$)[\s\S]+$

Required: Yes

countryCode

The country code for the country that the address is in.

Type: String

Length Constraints: Fixed length of 2.

Pattern: ^[a-zA-Z]+$

Required: Yes

postalCode

The postal code associated with the address.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: ^(?!\s*$)[\s\S]+$

Required: Yes

addressLine2

The second line of the address, if applicable.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 60.

Pattern: ^(?!\s*$)[\s\S]+$

Required: No

addressLine3

The third line of the address, if applicable. Currently, the Tax Settings API accepts the addressLine3 parameter only for Saudi Arabia. When you specify a TRN in Saudi Arabia, you must enter the addressLine3 and specify the building number for the address. For example, you might enter 1234.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 60.

Pattern: ^(?!\s*$)[\s\S]+$

Required: No

districtOrCounty

The district or county the address is located.

Note

For addresses in Brazil, this parameter uses the name of the neighborhood. When you set a TRN in Brazil, use districtOrCounty for the neighborhood name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^(?!\s*$)[\s\S]+$

Required: No

stateOrRegion

The state, region, or province that the address is located. This field is only required for Canada, India, United Arab Emirates, Romania, and Brazil (CPF). It is optional for all other countries.

If this is required for tax settings, use the same name as shown on the Tax Settings page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ^(?!\s*$)[\s\S]+$

Required: No

Address

Contents

Note

See Also