Skip to main content

Suggestions API

Use suggestions to find an organisation and its Swiss enterprise identification number (UID) before requesting detailed organisation data.

Method and pathPurpose
GET /suggestionsSearch the UID and ZEFIX registers by name prefix or exact UID.

prefix is required and must contain at least two characters. The optional parameters are:

  • limit
  • commercialRegisterEntryStatus
  • activeOnly — restricts ZEFIX results to active organisations; applies only to this operation
  • cache
  • phrasePartialMatch
  • withSource (deprecated; source data is now returned without it)

Example

BASE_URL="https://api.swisscom.com/products/business-identity-validator/swiss-registry"
TOKEN="<access-token>"

curl --get \
-H "Authorization: Bearer $TOKEN" \
--data-urlencode "prefix=Ajila" \
--data "limit=5" \
--data "activeOnly=true" \
"$BASE_URL/suggestions"

The response is an array of name and UID pairs:

[
{ "name": "Ajila AG", "uid": "CHE110105931" },
{ "name": "Ajila Holding AG", "uid": "CHE248743394" },
{ "name": "Ajimex SA", "uid": "CHE106800198" }
]

Select the intended result and retain its uid for the Organisations API; do not infer an identity from a partial match. Searching with a valid UID returns the exact match instead of a fuzzy result set.

See the generated operation page for full parameter details and responses. OAuth 2.0 client credentials are required; see Authentication and Authorization. Availability depends on your plan; see Plans and Base URLs.