Skip to content

Production Checklist

Use this page before enabling live traffic on the CheckName Partner API.

Contract and routing

  • POST /v1/name/assessment is integrated as the primary decision endpoint.
  • POST /v1/name/screening is integrated when you want one bundled assessment, company conflict, trademark, and optional domain response.
  • POST /v1/conflicts/search and POST /v1/trademarks/search are used directly only where you need raw sub-check output or custom orchestration.
  • Deprecated eligibility endpoints are kept only for temporary migration compatibility.
  • Your client can switch base URL cleanly between sandbox and production.

Authentication and secrets

  • Partner API keys are stored only in server-side infrastructure.
  • Sandbox and production use separate keys.
  • Keys are not exposed to browser, mobile, or desktop client code.
  • You have a documented key-rotation procedure.

Response handling

  • Your integration treats HTTP status as transport status, not business approval.
  • Your workflow reads top-level overallStatus as the decision.
  • Your workflow uses issues[].code for deterministic branching where needed.
  • For screening responses, your workflow handles resultState=PARTIAL, drivers[], primaryConcern, and executionIssues[].
  • Your integration detects semanticFailOpen and routes those cases according to policy.

Error handling and retries

  • Your client handles 400, 401, 422, 429, and 5xx responses explicitly.
  • Unchanged invalid requests are not retried.
  • Retries for 429 and transient 5xx responses are bounded and use backoff with jitter.
  • Retry-After is respected when present.

Logging and support readiness

  • You persist traceId for every response.
  • You also log the mirrored X-Trace-Id response header if your infrastructure is header-oriented.
  • Logs include endpoint, HTTP status, environment, and sanitized request context.
  • Your support runbook includes timestamp, endpoint, status code, and traceId.

Rollout controls

  • Sandbox behavior has been validated with realistic payloads.
  • Production rollout is gated behind a feature flag or equivalent control.
  • Monitoring is in place for latency, 4xx rates, 5xx rates, and 429 frequency.
  • You can disable or slow traffic quickly if upstream behavior changes.
  • Use Getting Started > Quickstart for the first end-to-end validation flow.
  • Use API Reference > Errors for the current error contract.
  • Use Operations > Support for escalation details.