Skip to main content

Address autocomplete search

GET 
/v1/address/autocomplete

Required States: SUSPECT, PROSPECT, KYC_IN_PROGRESS or ACTIVE

Returns a list of possible results relating to the input address information.

In order to prevent misuse of the service, a minimum of 4 characters should be provided in the query field and subsequent calls only be made upon change on input.

This service endpoint provides address lookup with appropriate security controls.

Each result will return a unique identifier that can be used to retrieve the full metadata associated with the address and is also used in the registration of the customer on the Ark platform.

Each result will consist of the following fields:

  • id: A unique identifier for the address instance, this identifier is utilised for metadata retrieval and customer registration.
  • address: Single string representation of the address to present to the end user.
  • canonicalId: The ID of the canonical or official address associated with this search result.

Known Limitation: The underlying address search service may return a different number of results for the same query across repeated calls. This is due to inconsistencies in the address search service's predictive search algorithm and is outside the control of this service. Consumers should not rely on a deterministic result count for a given query.

Request​

Responses​

OK

Last updated on