v1

latestOpenAPI 3.1.02026-07-241695611.0 MB

Business Autocomplete

Autocomplete

Suggest businesses matching a partial name, for typeahead UIs.

get/autocomplete

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.

The type of entity to suggest. Only business is currently supported.

business.namestring required

Partial business name to complete.

Example:apple

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'

Restrict suggestions to businesses registered in this state.

limitinteger

Maximum suggestions to return.

Response

Successful Response

querystring required

The query the suggestions were generated for.

Example response

{
  "query": "apple",
  "suggestions": [
    {
      "id": "b3f1c2d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "name": "apple computer inc",
      "states": [
        "CA",
        "DE"
      ],
      "registration_count": 12,
      "score": 0.96,
      "highlights": [
        {
          "field": "normalized_names",
          "snippets": [
            "<mark>apple</mark> computer inc"
          ]
        }
      ]
    }
  ]
}