---
title: "Autocomplete"
method: GET
path: "/autocomplete"
tags: ["Business Autocomplete"]
---

# Autocomplete

`GET /autocomplete`

Suggest businesses matching a partial name, for typeahead UIs.

## Query parameters

- `entity_type` 'business', required — Entity types the GET /autocomplete route can suggest. Only businesses are searchable today; officers, agents, and addresses require their own collections before they can join this enum.
- `business.name` string, required — Partial business name to complete.
- `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'PR' | 'VI' | 'AE' | 'AA' | 'AP' | 'GU' | 'AS'
- `limit` integer — Maximum suggestions to return.

## Response `200`

Successful Response

- V1AutocompleteResponse — Response for GET /autocomplete.
  - `query` string, required — The query the suggestions were generated for.
  - `suggestions` V1AutocompleteSuggestion[] — Suggestions ordered by relevance, best first.
    - `id` string, uuid, required — The domicile root registration id of the suggested business family. Resolves to an SOSRegistration.
    - `entity_type` 'business', required — Entity types the GET /autocomplete route can suggest. Only businesses are searchable today; officers, agents, and addresses require their own collections before they can join this enum.
    - `name` string, required — The business name closest to the query, in normalized form.
    - `states` string[] — States where the business holds registrations.
    - `registration_count` integer, required — Number of registrations in the business's family.
    - `score` number, required — Jaro-Winkler similarity between the normalized query and the matched name (0.0–1.0).
    - `highlights` V1AutocompleteHighlight[] — Matched fields with highlighted snippets.
      - `field` string, required — The document field the snippets were matched in.
      - `snippets` string[] — Matched values with ``<mark>`` tags around the matched tokens, one snippet per matched value.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/baselayer/apis/baselayer-api-service.md) · [All operations](https://skmtc.net/baselayer/apis/baselayer-api-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/baselayer/baselayer-api-service/revisions/0cc89938bc26/schema)