AddressFindOutputItem_v1

FieldTypeDescription
containerStringAn identifier representing a broader location (e.g., street, building, postal code area) or a specific address. If the type is "Address", this ID can be used in a Retrieve API call to get full address details. If the type is not "Address", this ID should be used as the container in a subsequent Find request to drill down into more specific address details.
addressStringThe suggested address resulting from the search input.
descriptionStringA human-readable description providing additional context for the suggestion, such as city or postal code.
typeStringThe category of the suggestion. "Address" indicates a complete address; other values (e.g., "Street", "Building") represent broader locations requiring further refinement.
highlightStringCharacter ranges indicating which parts of the address and description fields match the user's input. This can be used to emphasize matching substrings in the UI.