> ## Documentation Index > Fetch the complete documentation index at: https://docs.hi-doctor.ai/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Connect the Hi Doctor MCP connector at https://mcp.hi-doctor.ai/mcp. Add this URL as a remote HTTP MCP server in your client, then sign in and authorise access through OAuth. Setup: https://docs.hi-doctor.ai/mcp/connect. > > The REST API base is https://api.hi-doctor.ai. Hi Doctor Docs at https://docs.hi-doctor.ai/mcp searches documentation; connect to the product endpoint above for patient tools. > > 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. Every consultation is reviewed in full by an EU-licensed doctor, who decides on medical grounds only. No algorithm, assistant or API call approves a consultation, issues a prescription or changes a dose. The service is available in eight languages: English, Spanish, German, Dutch, Italian, French, Portuguese and Chinese. > > ## Rules an assistant must follow > > - Never invent, assume or infer a medical answer. "I don't know" is a real answer: ask the patient to pick the closest option rather than guessing for them. > - Never give medical advice and never suggest a medication or a dose. An EU-licensed doctor decides those. > - If a questionnaire returns `ineligible`, say so plainly. Do not retry with altered answers. > - Before anything that costs money or cancels a plan, state exactly what will happen and get an explicit yes. > - Cancellation takes effect at the **end of the paid period**, not immediately. Say so. > - An early order is irreversible: it creates the renewal consultation immediately and uses up the period's one early order. Explain that and get an explicit yes. > - Prescription and invoice links are medical documents. A `signed_redirect` link opens without signing in: give it only to the patient, never repeat it anywhere shared. > - Send option `value`s, not the labels shown to the patient. Labels are translated, values are stable. > - Never ask for card details. Payment happens on Stripe's hosted checkout via a link. > - On severe or sudden symptoms (chest pain, difficulty breathing, severe allergic reaction, suicidal thoughts), stop and direct the patient to their local emergency number. # Hi Doctor Business portal for Partner API teams > The Business portal at business.hi-doctor.ai lets partner teams follow consultations, manage API keys and webhooks, and export usage. The Hi Doctor Business portal at [business.hi-doctor.ai](https://business.hi-doctor.ai) is where a partner team follows its consultations and manages the Partner API integration without writing code. It shows patients, consultations and prescriptions, and manages API keys, webhooks, the team and usage exports. What each person can do depends on their role: Owner, Admin, Developer or Viewer. Last reviewed: 2026-11-04 ## How do I sign in? Sign in with the email address and password of your Hi Doctor account. Your account must be a member of your partner organisation. Hi Doctor adds the first members when your partner access is set up, so tell your Hi Doctor contact who should be an Owner. If you sign in without a membership, the portal shows that you have no partner access. Signing out clears the portal's data from your browser. ## How do I switch between live and test data? A switch in the header moves the whole portal between **Live** and **Test** data. Keys, webhooks, patients and consultations are always shown for the selected mode only. ## What can I do in each section? | Section | What you can do | | - | - | | Overview | See how many consultations are in each status for the selected mode, counted over all time. | | Patients | Find the patients you created by your `external_patient_id` and open their consultations. | | Consultations | Filter consultations by status, open one to see its status timeline, the doctor's decision category, information requests and prescriptions, answer an open information request (the portal shows which questions were answered and how many files were sent, never the answer values), and cancel it before a doctor opens it (see [Cancel a consultation](#cancel-a-consultation)). | | Prescriptions | See the structured prescription data reported to you. | | API keys | Create keys with chosen scopes, see when and from which network each key was last used (the IP address masked to its /24 or /48 network), rotate a key with a grace period of up to 24 hours and revoke a key immediately. A new secret is shown once. | | Webhooks | Add endpoints, choose event types, see each delivery and its response code, replay a delivery, send a test event and rotate the signing secret. The secret is shown once, as `whsec_` followed by standard base64; during the 24 hours after a rotation deliveries are signed with both secrets. An endpoint that Hi Doctor disabled after 50 consecutive failed deliveries, or after three days of failures, is shown as Disabled, like one you disabled yourself; enable it again from its detail page once it is fixed (see [Webhooks](https://docs.hi-doctor.ai/partners/webhooks.md)). | | Team | See every member of your organisation: name, email, role and when they were added. Every role can see the team. | ## What can each role do? | Action | Owner | Admin | Developer | Viewer | | - | - | - | - | - | | See patients, consultations and prescriptions | yes | yes | yes | yes | | Create, rotate or revoke live API keys | yes | yes | no | no | | Create, rotate or revoke test API keys | yes | yes | yes | no | | Manage webhook endpoints | yes | yes | test mode only | no | | See delivery bodies, replay, send test events | yes | yes | test mode only | no | | Cancel a consultation | yes | yes | test mode only | no | | Answer an information request | yes | yes | test mode only | no | | Export usage | yes | yes | no | no | | See the team | yes | yes | yes | yes | A key's scopes can never exceed what its creator's role may do. To change a member's role, write to [hello@hi-doctor.ai](mailto:hello@hi-doctor.ai). ## Cancel a consultation The portal's cancel follows the same rule as `POST /v1/partner/consultations/{id}/cancel/`: a consultation can be cancelled only while no doctor has ever opened it, which the consultation's `cancellable` field reports. Once a doctor has opened or decided it, the cancel fails with `409 not_cancellable`. A successful cancel sets the status to `cancelled` and voids the billing, and the consultation is never billed. Owners and Admins can cancel in both modes; Developers in test mode only; Viewers cannot cancel. Live cancels need live mode enabled for your organisation, and a suspended organisation cannot cancel. See [Consultation lifecycle](https://docs.hi-doctor.ai/partners/consultation-lifecycle.md#cancel-a-consultation) for the full rule. ## How do I export usage? Owners and Admins can export the usage ledger of the selected mode as a CSV file, `usage-ledger-live.csv` or `usage-ledger-test.csv`. It has one row per consultation, oldest first, with its billing `state` (`pending`, `billable`, `void` or `reversed`) and these columns: `ledger_id`, `consultation_id`, `external_reference`, `product_id`, `country`, `state`, `amount_cents`, `currency`, `recorded_at`, `billable_at`, `voided_at`, `reversed_at`, `reversal_reason`, `invoiced_at`, `invoice_reference`. Each export is recorded in the access log, like any read of consultation data; see [Security and compliance](https://docs.hi-doctor.ai/partners/security-and-compliance.md#access-logging). ## Good practice * Give each person their own account; never share a login. * Use the Viewer role for people who only need to follow consultations. * Store a new API key secret in your secret manager straight away. The portal cannot show it again. ## Frequently asked questions ### Who creates the first Business portal account? Hi Doctor adds the first members of your partner organisation when your partner access is set up. To change a member's role, write to [hello@hi-doctor.ai](mailto:hello@hi-doctor.ai). ### Can the portal show an API key secret again? No. A new secret is shown once, when the key is created or rotated. Store it in your secret manager straight away. ### Can a Developer manage live API keys? No. Developers can create, rotate and revoke test keys only. Live keys are managed by Owners and Admins. ### Does the portal show the patient's information-request answers? No. It shows which questions were answered and how many files were sent, never the answer values. ### When can I cancel a consultation in the portal? Only while no doctor has ever opened it, which the consultation's cancellable field reports. Owners and Admins can cancel in both modes and Developers in test mode only. ### Is reading data in the portal logged? Yes. Every read of patient, consultation, information request or prescription data, and every usage export, is recorded in the access log. ## Next steps > [card] [Authentication](https://docs.hi-doctor.ai/partners/authentication.md) > > Key format, scopes, rotation and revocation. > [card] [Security and compliance](https://docs.hi-doctor.ai/partners/security-and-compliance.md) > > Consent, data minimisation and access logging. Commercial questions: read the [partnership FAQ](https://docs.hi-doctor.ai/partnerships/faq.md) or write to [hello@hi-doctor.ai](mailto:hello@hi-doctor.ai). This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.