| Name | Description | Type | Additional information |
|---|---|---|---|
| Company |
The company the shipment is being shipped to. |
string |
String length: inclusive between 0 and 100 |
| Attention |
The person who the shipment is shipped to. |
string |
String length: inclusive between 0 and 100 |
| IsResidential |
Indicates of the shipment is going to a residential address. Null represents unknown. |
boolean |
None. |
| Country |
The country name for the address. |
string |
None. |
| AddressSource |
The source of the address during AddressVerification |
string |
None. |
| Street1 |
The first line of the address. |
string |
Required String length: inclusive between 1 and 100 |
| Street2 |
The second line of the address. |
string |
String length: inclusive between 0 and 100 |
| Street3 |
The third line of the address. |
string |
String length: inclusive between 0 and 100 |
| City |
The city component of the address. |
string |
Required String length: inclusive between 1 and 100 |
| Region |
The region or state component of the address. |
string |
String length: inclusive between 0 and 35 |
| Postalcode |
The postal code component of the address. |
string |
Must be a properly formed zipcode for the country specified. String length: inclusive between 0 and 12 |
| PostalZip4 |
The Zip4 component of an US address. |
string |
String length: inclusive between 4 and 4 |
| CountryCode |
The country code of the country for the address. |
string |
Required String length: inclusive between 0 and 2 |