Skip to main content
This FAQ answers the questions developers ask most often when they integrate the Hi Doctor Partner API. It covers access, test mode, keys, clinical decisions, webhooks, retries, limits and going live, with a link to the guide that gives the full detail. For commercial questions about a partnership, read the partnership FAQ. Last reviewed: 2026-11-04 Every answer here is a summary. The Partner API overview explains what the API does, the quickstart walks through a first test consultation, and the Partner API reference lists every endpoint.

Frequently asked questions

How do I get access to the Partner API?

Access to the Partner API is granted per partner agreement. Write to hello@hi-doctor.ai, and your Hi Doctor contact issues your first test key; live mode follows the signed partner agreement and data processing agreement.

Can I build before live mode is enabled?

Yes, with a test key that starts with hdp_test_ and works on test data only. Test consultations are synthetic, never reach a doctor and are never billed.

Does the API or my platform decide on treatment?

Neither. Every consultation is reviewed in full by an EU-licensed doctor, who decides on medical grounds only, and the partner never makes or changes that decision.

How do I authenticate requests?

Send your API key from your servers as Authorization: Bearer followed by the key. Each key works in one mode, test or live, and carries scopes that limit what it can do.

How do I know when a consultation changes?

Register a webhook endpoint. Each event is signed per the Standard Webhooks specification and carries the full consultation snapshot with a version number for ordering.

How do I retry a submission safely?

Send the same Idempotency-Key, path and body. Within 24 hours you get the stored original response instead of a second consultation.

What are the default rate limits?

600 requests per minute per API key and 1,800 per minute for all of a partner’s keys together. A limited request returns 429 with a Retry-After header.

Do partners receive prescription documents?

No. Partners receive structured prescription data; the patient receives the prescription as set out for their country.

Which countries can my platform offer?

Hi Doctor operates across the whole European Union: residents of all 27 EU member states can use the service, and every consultation is reviewed by an EU-licensed doctor. Some treatments are limited to specific countries by local rules, and the countries and products your platform offers are set in your partner agreement.

How do I go live?

Complete the go-live checklist and ask Hi Doctor for a review. Hi Doctor enables live mode for your partner once every item is in place.

Next steps

Quickstart

Your first test consultation in seven steps.

Authentication

Keys, scopes, rotation and revocation.

Webhooks

Signed events, retries and ordering.

Go-live checklist

What must be in place before live mode.
Commercial questions: read the partnership FAQ or write to hello@hi-doctor.ai.