TIC
Sign in to Lens

SearchAutocomplete

Autocomplete companies

Searches the companies collection by name and registration number. Returns slim autocomplete results. Requires the integrator-search-companies subscription feature.

POSThttps://lens-api.tic.io/search-autocomplete/companies

Authorization

x-api-keystringheaderrequired

Your API key, sent in the x-api-key header.

Bodyapplication/json

qstring | null
pageinteger

format: int32 · >= 1 · <= 2147483647

per_pageinteger | null

format: int32

Responses

Slim autocomplete response · application/json

foundinteger

format: int32

pageinteger

format: int32

outOfinteger

format: int32

searchTimeMsinteger

format: int32

hitsCompanyAutocomplete_Dto[] | null
Hide child attributes
companyIdinteger

format: int32

iso3166CountryCodestring | null
registrationNumberstring | null
legalEntityTypestring | null
localCompanyCodestring | null
elfCodestring | null
registrationDatestring | null

format: date-time

mostRecentRegisteredAddressCOstring | null
mostRecentRegisteredAddressStreetAddressstring | null
mostRecentRegisteredAddressPostalCodestring | null
mostRecentRegisteredAddressCitystring | null
mostRecentNamestring | null

How the query is matched

The request carries only q, page and per_page. Everything else is fixed by the API, which searches the companies collection as below.

Field searchedTypeDescription
names.nameOrIdentifierstringCurrent and former names of the business (could be legalname, particularName etc)
registrationNumberstringThe local registration number in the country
q
Optional; leaving it out searches with * and returns the first hits of the collection.
per_page
1 to 10; omitted means 10, more is answered with 400.
Always filtered
localCompanyCode:!=['E','EF'] && legalEntityType:!=['Oskiftade dödsbon','Utländska juridiska personer','Enkla bolag'] && isCeased:=false

Ceased companies, estates of deceased persons (Oskiftade dödsbon), foreign legal entities (Utländska juridiska personer), simple partnerships (Enkla bolag) and the local company codes E and EF are never returned.

The last word is a prefix
While someone types, the word under the cursor matches the start of a word: "volv" finds Volvo. Earlier words match whole.
Typos are forgiven
Words of 4 to 6 characters match with one typo, 7 or more with two. Shorter words must be exact.
Words drop from the end
When no hit contains every word, the last words are dropped until something matches, so a longer query narrows the list without emptying it.
Ranked by text match
Hits come back best match first (_text_match:desc); there is no other sort.

Try the autocomplete

Type as your users would and watch the hits arrive through the proxy, listed the way an integration shows them.

Autocomplete · companies
Authorization

Stored in this browser only (until you forget it) and sent as the x-api-key header through the documentation proxy.

Try

Each pause while typing (300 ms) sends one request, which counts against your API key's quota.

Request 
curl -X POST "https://lens-api.tic.io/search-autocomplete/companies" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "page": 1,
  "per_page": 10
}'
Enter your API key to send.