API Reference Overview¶
Legiqo GmbH's CheckName Partner API exposes one primary decision endpoint and supporting endpoints for B2B integrations:
POST /v1/name/assessmentPOST /v1/conflicts/searchPOST /v1/name/eligibility(deprecated)
Endpoint roles in the business workflow¶
These endpoints do different jobs and should not be treated as interchangeable:
| Endpoint | Main purpose | Best used when |
|---|---|---|
POST /v1/name/assessment |
Return a business-ready risk outcome for a proposed name | You need a top-level decision for onboarding, filing, or internal review |
POST /v1/conflicts/search |
Return potentially conflicting Swiss company names with matching signals | You need analyst-facing evidence, explainability, or review support |
POST /v1/name/eligibility |
Legacy structural/legal checks only | You are temporarily supporting an older integration during migration |
This reference documents the integration API, not the end-user workflow at checkname.ch. If you are building a partner product or internal tool, this is the surface you integrate against.
Primary endpoint semantics¶
POST /v1/name/assessmentis the main endpoint for partner integrations.- HTTP
200means the assessment executed successfully. - Business decision outcome is in
assessment.overallStatus: CLEAR_TO_FILEMINOR_RISKS_DETECTEDMANUAL_REVIEW_ADVISEDREGISTRY_REJECTION_LIKELY- Correlate support/debug requests with
X-Trace-Idandmetadata.traceId.
What POST /v1/name/assessment actually does¶
At a functional level, the assessment endpoint combines several layers into one response:
- Deterministic naming checks for syntax, legal form, geographic wording, and restricted terms.
- Optional semantic analysis when
checkLevel=fullto interpret descriptiveness, purpose mismatch, translations, and implied regulated activity. - Risk-profile mapping that converts triggered rule codes into
INFO/WARNING/ERRORseverities. - Final aggregation into one top-level outcome in
assessment.overallStatus.
This means the assessment endpoint is intended to be your operational "decision engine", not just a rule dump.
What POST /v1/conflicts/search actually does¶
The conflict-search endpoint is designed to answer a different question: whether the proposed name appears close to already registered Swiss company names.
It evaluates similarity using multiple signals, including:
- identity or near-identity
- visual similarity
- phonetic similarity
- subset and token overlap logic
Use it when a human reviewer, case handler, or analyst needs context about which registered names may create confusion or filing risk.
Response model philosophy¶
For partner integrations, it helps to separate three layers of meaning:
- transport success: HTTP status and
error.code - business outcome:
assessment.overallStatus - exact machine triggers:
flags[]
That separation lets you distinguish "the API call failed", from "the API worked but the name is risky", from "here are the precise reasons why".
Versioning¶
- Paths are versioned under
/v1. - Breaking changes are announced through the changelog and partner communication channel.
Content type¶
- Request:
application/json - Response:
application/json
Authentication¶
All endpoints require X-API-Key.