The complete address of the Recipient or Department (in case if the address is not pointed to any individual recipient).
| Name | Type | Description | Notes |
|---|---|---|---|
| name | String | The name of the Recipient. <br /> `Max length = 40` | |
| addressLine1 | String | The addressLine1 contains the Flat number, Building or Apartment Name/number (if any) or company name (if not residential) of the Recipient. <br /> `Max length = 40` | |
| addressLine2 | String | The addressLine2 contains the Area or Street Name. This is an optional field. <br /> `Max length = 40` | [optional] |
| addressLine3 | String | The addressLine3 contains other details for easy reach, e.g. Landmark. This is an optional field. <br /> `Max length = 40` | [optional] |
| cityTown | String | The name of the city or town the Recipient belongs to. | |
| stateProvince | String | The name of the State or Province the Sender belongs to. It is the `2-letter` State or Province Code for US or Canadian address(es). <br /> Below is the hyperlink for CA country that will navigate to its Province/State Codes page. Similarly, respective country users can check for their country- State/Province codes. <br /> Please switch to the `Search` tab, select `Country codes` radio button, enter the required country name or country code, and then click `SEARCH` button . <br /> `Max length = 2` | |
| postalCode | String | The Postal Code or ZIP Code of the address.<br /> For US addresses, use either the `5-digit` or `9-digit` ZIP Code in one of the following formats: '12345' or '12345-6789'. <br /> While for CA addresses, use a `six-character` alphanumeric string Postal Code in this format: 'A1A 1A1'. ERR supports only US addresses.<br /> NOTE: USPS supports only US location. | |
| countryCode | String | The country in which the recipient's address is located. The value will be the two-character ISO Code of the country from the ISO country list. <br /> Use ISO 3166-1 Alpha-2 standard values. For best results this should be included, especially if the country name does not appear in any of the unparsedAddressLines. <br /> Below is the hyperlink, please select `Country codes` and then click `SEARCH` button. <br /> NOTE: USPS supports only US location. | |
| company | String | The name of the company, in case if the Recipient address is not residential. | [optional] |
| phone | String | This is recipient's phone number. Enter the digits with or without spaces or hyphens. <br /> `Max length = 15`. | [optional] |
| String | This must be recipients's valid email. <br /> `Max length = 50` | [optional] | |
| residential | Boolean | The specified address can be Residential or Official. In case if the address is Residential, the boolean value will be 'true', else it will take 'false'. | [optional] |