---
title: "GET /v1/intl_addver/completions"
method: GET
path: "/v1/intl_addver/completions"
tags: ["International API"]
---

# GET /v1/intl_addver/completions

`GET /v1/intl_addver/completions`

Returns address completion previews for a partial address string, suitable
for populating an autocomplete dropdown.

**Regular mode** — supply `partialStreet` to search by partial street address.
Results may include directly-resolvable `Address` results and non-`Address`
results (e.g. `BuildingNumber`) that represent buildings/complexes requiring
a follow-up call.

**Advanced mode** — supply `advanced=true` and a `container` ID (the `id` of a
non-`Address` result from a previous regular call) to drill into a building or
complex and retrieve individual unit addresses.

Results with `type: "Address"` can be fully resolved by passing their `id`
to `POST /completions`.

- Results are biased by the caller's IP address by default; pass
`disableIPBiasing=true` to turn this off.
- Does not consume a lookup.

## Query parameters

- `partialStreet` string
- `container` string
- `countriesFilter` string
- `limit` integer
- `language` string
- `cityFilter` string
- `streetFilter` string
- `postalOrZipFilter` string
- `advanced` boolean
- `disableIPBiasing` boolean
- `standardFallback` boolean
- `useEnhancedChinaDataset` boolean

## Response `200`

The request has succeeded.

- object
  - `status` 'success' | 'error', required
  - `message` string, required
  - `data` IntlAddressPreview[], required
    - `id` string — The unique identifier for this result. If the result is a fully resolvable address (`type` is `Address`), pass this to `POST /completions` to retrieve the full address. Otherwise, pass it as the `container` query parameter to `GET /completions` to drill down further.
    - `type` string — The type of result. `Address` means this can be resolved directly via `POST /completions`. `Container` means the result represents a building or complex — perform another `GET /completions` with this `id` as `container` to get individual unit addresses.
    - `text` string — The human-readable address suggestion text.
    - `highlight` string — Character ranges within `text` that match the search input, for bolding in UI.
    - `description` string — A secondary description of the result (e.g. city and country).
    - `error` string — An error message if the lookup failed for this result.

## Other responses

- `400` — The server could not understand the request due to invalid syntax.

---

[API](https://skmtc.net/postgrid/apis/postgrid-address-verification-api.md) · [All operations](https://skmtc.net/postgrid/apis/postgrid-address-verification-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/postgrid/postgrid-address-verification-api/revisions/537d2bbc624a/schema)