Onboarding

How a partner should evaluate, subscribe, and move into active use.

This page focuses on access, evaluation flow, welcome email, API keys, and production readiness rather than clinical payload details.

Access Model

Evaluation first, commercial access second

Trial

Fast technical evaluation

Use a trial account and API key to validate connectivity, calculation payloads, search, and label search.

Commercial

Licensed active use

Commercial access is for active product use, pilot work, and production deployments under subscription or enterprise terms.

Same Account

One onboarding path

The same account created during trial registration can move into commercial access without restarting onboarding.

Recommended Flow

What a partner technical review should look like

1

Register

Create a trial account and receive an issued API key plus a welcome email.

2

Validate

Use the live demo and docs to confirm the API supports representative search and calculation flows.

3

Subscribe

Move the same account into commercial monthly or annual access through hosted checkout.

4

Deploy

Continue into active use, pilot rollout, or broader production planning with the licensed account.

Licensing Path

What partners should clarify during review

Share

Product and company context

Clarify target users, deployment scope, and whether the review is evaluator-only, pilot, or production-bound.

Share

Expected usage profile

Document likely request volume, tenancy model, and whether the integration is single product or OEM.

Clarify

Scope requirements

Confirm whether dog/cat commercial scope is sufficient or whether broader future scope is expected.

Outcome

Production readiness path

Define what changes between evaluation access and active licensed use, including support expectations.

API Keys

What partners should know about credential handling

Issued once

The raw API key is returned at registration time and should be stored securely by the integrator.

Sent as bearer auth

Use Authorization: Bearer <API_KEY> on authenticated requests.

Rotation supported

If a key must be replaced, rotation should happen through the managed key lifecycle rather than ad hoc duplication.

Operational Notes

What happens behind the scenes

Welcome email

Trial registration attempts direct welcome-email delivery and falls back to queue-backed delivery if needed.

Hashed auth state

Credential validation and sync use hashed auth state rather than exposing raw key data operationally.

Subscription-aware access

Commercial access changes are reflected through managed subscription and access-state handling.