Skip to main content
A Partner API consultation moves through seven steps: your platform lists products, fetches the questionnaire, uploads files and submits, then an EU-licensed doctor reviews and decides. You follow every change through six public statuses, delivered as signed webhooks. This page explains the roles, the flow and the lifecycle before you write code in the quickstart. Last reviewed: 2026-11-04 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.

Who does what in a partner consultation?

What are the seven steps?

  1. List your products for a country with GET /v1/partner/products/.
  2. Fetch the questionnaire schema for the product with GET /v1/partner/questionnaires/{slug}/.
  3. Upload photos and documents with POST /v1/partner/files/. Each returns an upload_id.
  4. Submit the consultation with POST /v1/partner/consultations/: patient, consent, plan, dosage and every answer in one request.
  5. Follow the consultation through webhook events, or read it with GET /v1/partner/consultations/{id}/.
  6. If the doctor needs more information, answer the information request with structured answers and files.
  7. When the doctor decides, the consultation becomes approved or rejected. Any prescription appears as structured data in prescriptions[].

Which statuses can a consultation have?

There is no completed status. The clinical outcome lives in decision, each prescription has its own status, and billing state lives in billing. See Consultation lifecycle.

How do test and live mode differ?

Test keys create synthetic consultations that never reach a doctor. You move them through the lifecycle yourself with an explicit test endpoint. See Test mode. Live mode is enabled for each partner by Hi Doctor once the go-live checklist is complete.

Frequently asked questions

Who makes the clinical decision in a partner consultation?

The reviewing doctor. 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.

Can a consultation be cancelled?

Yes, while no doctor has opened it. Once a doctor opens the consultation it moves to in_review and can no longer be cancelled.

Is there a completed status?

No. The clinical outcome lives in decision, each prescription has its own status, and billing state lives in billing.

What happens when the doctor needs more information?

The consultation moves to info_requested and carries an open information request. Your platform answers it with structured answers and files, and the consultation returns to in_review.

Does the partner see why a doctor declined?

The partner receives a fixed category in decision.reason_category. The doctor’s own note is never shared.

Do test consultations reach a doctor?

No. Test consultations are synthetic, never reach a doctor and only move when you advance them with the test endpoint.

Next steps

Quickstart

Run your first test consultation, from key check to a signed webhook.

Consultation lifecycle

The consultation resource, statuses and cancel rule.

Webhooks

Signed events, retries and the ordering rule.
Commercial questions: read the partnership FAQ or write to hello@hi-doctor.ai.