Address Parameter Type

The “Address” type parameter is one of the components that produces object type output value. It also provides some out-of-the-box validation, such as all fields are mandatory, contributing to elaborate data collection. The value type is object.

Field	Type	Description
name	string	Label of the widget. Example: Buyer address
hintText	string	Provides help text describing what value is expected in control. Example: Define buyer address
defaultValue	One of: None Buyer Seller Licensee	(optional) Default value. Example: Buyer

Options Example

{
  "name": "Seller address",
  "hintText": "Provide seller address",
  "defaultValue": "Seller"
}

Value Fields

Field	Type	Description
addressLine1	string	Address Line1 - street address. Example: 123 Main Street
addressLine1	string	Address Line 2 - door number. Example: Apt 4B
postCode	string	Post or ZIP code. Example: 12345
city	string	City or town name. Example: Cityville
state	string	State name or abbreviation. Example: S
country	string	Country code according to standard. Example: ST

Value Example

{
  "addressLine1": "123 Main Street",
  "addressLine2": "Apt 4B",
  "postCode": "12345",
  "city": "Cityville",
  "state": "S",
  "country": "ST"
}