Skip to content

Getting Started Overview

This section helps partner engineering and product teams go from access request to production launch.

What you are integrating

The CheckName Partner API is Legiqo GmbH's B2B integration surface for Swiss company-name workflows.

It is not the consumer-facing experience at checkname.ch. That public product is designed for end users running searches directly, while this API is designed for partners embedding the capability into their own applications, onboarding flows, and internal tooling.

This API is not self-service. Access, pricing, and onboarding are handled individually for enterprise B2B partners via contact@legiqo.com.

Depending on your product, the API can support:

  • customer-facing onboarding flows
  • internal legal/compliance review desks
  • assisted filing and registry-preparation workflows
  • operational queues where risky names must be escalated

The core idea is:

  • POST /v1/name/assessment tells you how risky or acceptable a proposed name looks from a rules and policy perspective
  • POST /v1/conflicts/search gives you supporting evidence about similar existing Swiss company names
  • flags[] and assessment.overallStatus let you turn the result into product behavior

Integration flow

  1. Commercial onboarding: contact contact@legiqo.com to discuss your use case, pricing, and rollout model.
  2. Access: receive API key(s) and environment URL(s) from Legiqo.
  3. Connectivity: run the quickstart requests and validate response handling.
  4. Business mapping: map risk levels and issues to your product decisions.
  5. Go-live: configure monitoring, retry behavior, and support escalation.
  1. Integrate /v1/name/assessment as your primary decision endpoint.
  2. Add /v1/conflicts/search to show potentially conflicting registered names.
  3. Use /v1/name/eligibility only for legacy compatibility during migration.

In most partner implementations:

  • CLEAR_TO_FILE means the workflow can proceed automatically
  • MINOR_RISKS_DETECTED means proceed with user/operator warning
  • MANUAL_REVIEW_ADVISED means route to compliance/legal/manual queue
  • REGISTRY_REJECTION_LIKELY means block, require correction, or escalate

This mapping is not imposed by the API, but it is the intended integration pattern for most operational use cases.

Choosing a risk profile

riskProfile lets you choose how aggressively the API maps triggered issues into final severity.

Available profiles:

  • balanced: default and recommended for most production partner integrations
  • conservative: stricter handling for partners who want borderline names escalated sooner
  • relaxed: softer handling for early-stage intake flows or exploratory checks

Important: the profile does not change which checks run. It changes how triggered flags are classified, which can change assessment.overallStatus.

In the current API version, the practical profile difference is mainly how WARN_PURELY_DESCRIPTIVE is treated:

  • balanced: mapped to WARNING, which usually results in MANUAL_REVIEW_ADVISED
  • conservative: mapped to ERROR, which usually results in REGISTRY_REJECTION_LIKELY
  • relaxed: mapped to INFO, which usually results in MINOR_RISKS_DETECTED

If you are unsure which profile to start with, use balanced.

Deprecation

POST /v1/name/eligibility is deprecated and should not be used for new builds.

Security baseline

  • Keep API keys in your secret manager only.
  • Never ship keys in client-side code.
  • Rotate keys on employee role changes and incident response.

Use of the partner API is subject to Legiqo's Terms and Conditions, unless your signed partner agreement or order form defines superseding terms.

For enterprise access, pricing, and onboarding questions, contact contact@legiqo.com.