Addresses
Find addresses
Search for address suggestions from a free-text query.
Use this endpoint as step 1 in an assisted address-entry flow.
Request guidance:
- Provide a user-entered text value such as postcode, street name, or partial address.
- Provide container when refining from a previous response.
- Include a valid bearer token; this is an authenticated user endpoint.
Recommended flow:
- Call POST /user/addresses/lookup/find with text from the user input.
- If container-type results are returned, call this endpoint again with container to drill down.
- When an address result is selected, call POST /user/addresses/lookup/retrieve with its id.
- Persist the final address with POST /user/addresses.
Behavior notes:
- Returns suggestions only; no address is saved to the account.
- Responses may include both final addresses and intermediate container nodes.
- Empty results are valid and should be handled in UI as “no matching addresses found”.
POST
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
200 - application/json
Find a list of addresses, or containers to refine the user's search
The ID of the location, use this to retrieve the full address
A description of the location or "container"
The type of location, e.g. "Address", "Postcode", etc.
Available options:
Container The text matching the provided search
A comma-separated list of highlighted indices in the text, ie. 0-2,3-9