Skip to content

Quickstart

This quickstart verifies end-to-end connectivity and payload handling for a backend partner integration.

Use it to confirm that your system can authenticate, send assessment requests, and interpret the decision-oriented response model exposed by Legiqo's CheckName Partner API.

1) Main assessment endpoint

curl -X POST "https://api.test.checkname.ch/v1/name/assessment" \
  -H "X-API-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "companyName": "Alpen Data AG",
    "legalForm": "stock_corporation",
    "activityScope": "Software development services",
    "language": "de",
    "ownerSurname": null,
    "legalSeat": "Zurich",
    "languageVariants": [],
    "checkLevel": "full",
    "riskProfile": "balanced"
  }'

Expected outcome:

  • HTTP 200 OK
  • Read outcome from assessment.overallStatus
  • Use flags[].code and flags[].severity for deterministic client behavior
  • Store X-Trace-Id (response header) and metadata.traceId for support correlation

riskProfile controls how triggered issues are mapped into final severity:

  • balanced is the default
  • conservative is stricter
  • relaxed is more permissive

See API Reference > Assessment Checks and Codes for the exact current differences.

curl -X POST "https://api.test.checkname.ch/v1/conflicts/search" \
  -H "X-API-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Alpen Data AG",
    "limit": 25,
    "minRisk": "Low"
  }'

Expected outcome:

  • Ordered matches by risk level and similarity strength
  • Your UI can use risk level as the first-level decision signal

3) Deprecated eligibility endpoint (legacy only)

POST /v1/name/eligibility is deprecated. Keep it only for backward compatibility while migrating to POST /v1/name/assessment.

curl -X POST "https://api.test.checkname.ch/v1/name/eligibility" \
  -H "X-API-Key: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "companyName": "Alpen Data AG",
    "legalForm": "stock_corporation",
    "activityScope": "Software development services",
    "language": "de",
    "ownerFullName": null,
    "checkLevel": "full"
  }'