Properties
| Name | Type | Description |
|---|---|---|
| city | string | The name of the city. Required if the `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided. |
| country | string | The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, **NL**. |
| houseNumberOrName | string | The number or name of the house. |
| postalCode | string | The postal code. Required if the `houseNumberOrName`, `street`, `city`, or `stateOrProvince` are provided. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries. |
| stateOrProvince | string | The abbreviation of the state or province. Required if the `houseNumberOrName`, `street`, `city`, or `postalCode` are provided. Maximum length: * 2 characters for addresses in the US or Canada. * 3 ch |
| street | string | The name of the street. Required if the `houseNumberOrName`, `city`, `postalCode`, or `stateOrProvince` are provided. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ViasAddress",
"title": "ViasAddress",
"properties": {
"city": {
"description": "The name of the city. Required if the `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.",
"type": "string"
},
"country": {
"description": "The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, **NL**.",
"type": "string"
},
"houseNumberOrName": {
"description": "The number or name of the house.",
"type": "string"
},
"postalCode": {
"description": "The postal code. Required if the `houseNumberOrName`, `street`, `city`, or `stateOrProvince` are provided.\n\nMaximum length:\n\n* 5 digits for addresses in the US.\n\n* 10 characters for all other countries.",
"type": "string"
},
"stateOrProvince": {
"description": "The abbreviation of the state or province. Required if the `houseNumberOrName`, `street`, `city`, or `postalCode` are provided. \n\nMaximum length:\n\n* 2 characters for addresses in the US or Canada.\n\n* 3 characters for all other countries.\n",
"type": "string"
},
"street": {
"description": "The name of the street. Required if the `houseNumberOrName`, `city`, `postalCode`, or `stateOrProvince` are provided.",
"type": "string"
}
},
"required": [
"country"
],
"type": "object"
}