AddressFindInput_v1

FieldTypeDescription
addressStringA free-text input used to search for address suggestions. The input does not require structured formatting (e.g., separate street, postal code, or city fields). Users can enter any combination of available address details, and the API will attempt to match and return relevant results.
countryStringThe country for the address search (e.g., US).
noteStringA custom note for display in the transaction log.
containerStringEnables searching within a specific address container. If the initial search returns a broader location (e.g., a street, a building, or a postal code area), the API provides a container ID representing that location. Using this container in a subsequent findAddress request allows users to drill down one layer deeper to retrieve more specific address details within that location.
addressOptionsAddressOptions_v1Additional options to customize the address search (e.g., parsing rules, separators).