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?
What can each role do?
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.
Cancel a consultation
The portal’s cancel follows the same rule asPOST /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 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.
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.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
Authentication
Key format, scopes, rotation and revocation.
Security and compliance
Consent, data minimisation and access logging.