Reference · v1.0.0
All operations
Pick an operation on the left, or search with ⌘K / Ctrl K. Each operation shows permissions, parameters, navigable schemas, request and response examples, code in five languages and a console to try it with your token.
A minha licença2 operationsLicence of the current clinic (clinic administration) and light state for banners.
Academia6 operationsInternal team training: role-based paths, courses, lessons, tests and certificates. Team only.
Acompanhamento6 operationsPost-operative milestones (d1 to m18), board, detail with closed loop, NPS, photo requests and recovery tasks.
Agenda26 operationsCalendar by professional or room, appointments with server-side conflict checks, availability, occupancy, reminders, public appointment link, waiting list and personal read-only sync with external calendars.
Agente de IA17 operationsRequests handled by the voice agent and written assistants, hand-over to the team, alarm signs, corrections and sample review.
Ajuda3 operationsHelp Center, contextual help and System Manual.
Ambiente1 operationsWhich environment the server is in. Outside production nothing leaves the server (email, SMS, WhatsApp, webhooks, payments, invoicing, external assistant, backups to the external destination) without authorisation in the server .env; the app and the web show the «Test environment» banner. Every API response outside production carries X-AX-Ambiente.
Análise e plano27 operationsDrawings on photos, face protection and export, trichoscopy image counting, trichogram, hair mass and same point, future loss, expectations, facial proportions, actual surgery, day 0 areas, implanted per zone and parameter tuning.
Apresentação do AnagenSys2 operationsPublic product page and demo requests (no session).
Atividade7 operationsFull activity log of the clinic: who signed in, which page or screen they opened, which record or patient they viewed, what they created, changed, deleted or exported. Never clinical content.
Auditoria5 operationsImmutable access and action log, with chain verification.
Autenticação5 operationsTeam sign-in (password → second factor → confidentiality term), refresh and sign-out.
Avisos de fornecedores (CRM)12 operationsAddresses called by providers (WhatsApp/Meta, PBX, voice agent). Each clinic is identified by its own number, account or secret; never by default.
Avisos de fornecedores (comercial)4 operationsPayment notifications from the provider, from payment terminals (SumUp and Stripe) and document status from the invoicing software. The clinic is resolved from the record (reference, order or document) and validated with that clinic's key; payments only become paid after confirmation by the provider's API.
Avisos no telemóvel8 operationsRegistration of devices with the app that receive system notifications, per-category preferences and test notification. Notifications never carry clinical or personal content: only the clinic name, a generic sentence and the screen link (in the data, invisible on the lock screen). Sending is done by the scheduler from the core notifications.
Caixa7 operationsDaily till: opening with an initial balance, in-person payments, cash-ins and withdrawals, closing with a count per method and difference.
Caixa de entrada11 operationsMultichannel service (portal, WhatsApp, Instagram, Messenger, email, SMS, website chat) in a single inbox linked to the record, with queues, departments, internal notes, translation and AI suggestions.
Campanhas de marketing10 operationsBlock-based campaign editor, count of who can receive, mandatory clinical approval, scheduling, test and statistics.
Carteira5 operationsPatient wallet: credits, advances and prepayments, use of the balance in payments (no new invoice), refunds with a reason and reversals. Immutable entries in cents; the API returns euros plus the *_centimos pair.
Chat do site e subscrições8 operationsPublic endpoints: website chat, unsubscribe and subscription confirmation, and click tracking.
Chat interno16 operationsDirect, group, department, patient and surgery channels; mentions, attachments, read receipts and tasks from messages. Team only.
Clínica pública2 operationsClinic choice in the app (patient mode) by code; no authentication.
Comissões e honorários2 operationsSales team commissions (never for doctors) and doctors' fees per own act; those who do not manage figures see only their own.
Comunicados5 operationsInternal notices with read confirmation and who has not read yet.
Consentimentos9 operationsConsent collection per purpose (no pre-selected answers), privacy notice, information delivery and reflection period, patient and physician signatures, sending for signature at home, and proof of each consent. Records are immutable.
Consultas16 operationsClinical consultation: creation with the history pre-filled from the last signed consultation, draft saving with live eligibility, signing with a SHA-256 fingerprint (afterwards only addenda), feasibility validation, scribe and pre-analysis by the clinic's AI assistant (always proposals), completeness before surgery and human decision on proposals. The generic resource /r/consultas lists and filters consultations.
Contas pagadoras e convenções3 operationsPaying-account statements (sub-accounts with balances) and procedures split between a payer or agreement and the patient; the payer's share is invoiced to the account.
Definições5 operationsClinic and platform settings; test email.
Documentos17 operationsIssuing from approved templates with automatic fields, preview, sending for signature with a one-time code, on-screen or qualified signature, sharing in the portal, cancellation and public verification by the XXXX-XXXX code.
Escudo de entrada3 operationsProtection of every sign-in (team and portal): device verification by work per attempt (find n such that SHA-256("salt:n") starts with «bits» zero bits), per-account wait, traps, origin blocking and trusted device. Bodies of POST /auth/entrar, /portal/auth/codigo, /portal/auth/entrar and /portal/auth/registar accept escudo_desafio, escudo_solucao and dispositivo_confiavel; responses 428 CHALLENGE_REQUIRED {motivo, desafio}, 429 ACCOUNT_COOLDOWN {espera} (+ Retry-After), 403 BLOCKED and 401 identical to wrong credentials for automated attempts. Tokens include dispositivo_confiavel (store securely and send on later sign-ins).
Exportação5 operationsFull clinic data export and read tokens for analytics tools.
Ficha do paciente15 operationsSingle patient record: header, clinical alerts, episodes, journey and sections from every module (only those the caller may see), summary by the clinic's AI assistant, duplicates, assisted merge, medication alerts before prescribing and record import. Clinical data is only returned to callers with ficha.clinica and the patient in scope; administration, sales and reception never receive clinical content (data protection ceilings). The generic resources /r/pacientes, /r/episodios, /r/episodios_equipa and /r/pacientes_alertas are documented under «Resources».
Ficheiros2 operationsUpload and short-lived signed links.
Fluxo do dia3 operationsDay board by station (to arrive, admission, preparation, extraction, implantation, recovery, exit) with time per station, and waiting-room screen with minimal data.
Formulários10 operationsClinical form builder (steps, sections, 12 question types, conditional rules, scoring with bands, alarms and alerts), versions, template library, translation by the clinic's AI assistant, completion by the team or by integrations and fill-in requests by link. The generic resources /r/formularios and /r/formularios_respostas are documented under «Resources».
Formulários por ligação3 operationsPublic completion by link, without a session: the link token identifies the request, the patient and the clinic. Used by the app in patient mode and by anyone embedding the form elsewhere. Responses always await validation; the patient only gets a receipt confirmation.
Funil e leads11 operationsLead capture: lead creation from forms and ads, stage funnel with target times, decision, next action, distribution, duplicates, merge and conversion to patient.
Galeria clínica26 operationsCaptures per milestone, photos with quality scoring, previous-photo overlay, comparison, review of patient uploads, sharing, face blurring and 3D models.
Indicadores3 operationsFour groups (financial, sales, operations, service) with previous-period comparison, charts and CSV export.
Integrações8 operationsIntegration usage, event catalogue and webhook testing.
Licenças20 operationsClinic licences: dashboard, list, new-clinic wizard and actions (superadministration).
Mapa de cirurgias16 operationsLifecycle pre-booked → reserved → validated → confirmed (only with a valid surgical consent) → in progress → completed, team with conflict checks, fitness, indicators, weekly roster, theatre occupancy and pre-operative checklist.
Marcador e chamadas15 operationsCall lists with scripts, blocking of commercial calls without consent, click to call and statistics.
Modelos de IA6 operationsLocal AI service first and external service as fallback, per use.
Motor de cálculo8 operationsEngine parameter versions (section 5 table of the analysis), approved only by each clinic's clinical board.
Operação da plataforma15 operationsEncrypted backups (daily, weekly, monthly), integrity checks, immutable external destination, restore tests in a separate schema, vulnerabilities, penetration tests and continuity exercises, hosting and subprocessors. Long actions are queued (202) and the scheduler runs them within minutes. Reserved to platform super administrators (403 so_superadmin / segundo_fator_necessario for everyone else, including clinic administrators).
Pagamentos15 operationsPatient payment plan, MB WAY requests, Multibanco references and payment links (provider and credentials per clinic), manual receipts, cancellation, refund and tax documents issued by the clinic's certified invoicing software. Card data is never handled.
Painel4 operationsRole-based dashboard: cards from the modules visible to the person, ordered by role and preferences, in the single block format.
Painel cirúrgico22 operationsSurgery day: phases with timer and pauses, graft counting by FU type (1, 2, 3, 4+), batches with time out of body, sampled transection, nursing and anaesthesia with lidocaine mg/kg alert, per-phase checklists, discharge and definitive closing.
Parceiros9 operationsPartner portal: doctors and clinics referring patients. Own account with email verification and clinic approval. Partners see only their referrals and the status; clinical information (dates, procedure and milestones) only with the patient's express authorisation recorded by the clinic. Referral rewards only for partners who are not doctors.
Authentication: `POST /parceiros/auth/entrar` returns `token`; send it in the `X-AX-Parceiro` header (or `Authorization: Bearer axp_…`). 5 consecutive failures lock the account for 15 minutes.
Perfil13 operationsPersonal data, password, second factor and sessions.
Permissões20 operationsProfile × module × scope (own, team, department, all) × phase matrix, permissions per position, hidden or read-only fields per profile, per-person exceptions and effective permissions per person.
Planos cirúrgicos20 operationsSurgical plan with the server-side calculation engine: need per zone, donor capacity, sessions, balance, scenarios, versions, fingerprinted approval, simulation and proposal.
Plataforma — Apresentação13 operationsAnagenSys presentation content and demo requests (product management).
Portal · Cuidados por fase2 operationsCare videos and articles approved by the clinical director, available by day after surgery.
Portal — acessos1 operationsWho accessed the patient's data.
Portal — autenticação4 operationsPatient portal sign-in and registration.
Portal — autorizações5 operationsConsents per purpose, reflection and revocation.
Portal — documentos7 operationsShared documents, signatures, forms and uploads.
Portal — fotografias2 operationsGuided upload with light and focus check.
Portal — início2 operationsPatient portal summary and updates.
Portal — marcações9 operationsBook, reschedule, cancel, confirm and video consultation.
Portal — mensagens3 operationsSecure messages with the team.
Portal — os meus dados8 operationsContacts, allergies, preferences, data subject rights and account.
Portal — pagamentos2 operationsBalance, invoices and MB WAY/Multibanco/link payments.
Portal — plano5 operationsApproved plan, simulation with notice, 3D model and proposals.
Portal — propostas e pagamentos3 operationsThe authenticated patient views their sent proposals, accepts or declines, sees payments and pays by MB WAY, Multibanco or link.
Portal — recuperação2 operationsPost-operative milestones and instructions per stage.
Proposta pública6 operationsProposal page via personal link (64-character token; only its SHA-256 is stored). The clinic is the one that owns the proposal. No session; forms with CSRF, honeypot field and per-address rate limit.
Propostas18 operationsProposals from the approved plan (M3) or manual: options, extras, lines, discount with approval above the profile limit, instalments, currency with fixed exchange rate, seal (SHA-256), sending with a personal link, acceptance with proof, decline, revision, reactivation and cancellation. Margins and internal costs only for those who see clinic-wide figures.
Proteção de dados11 operationsData protection officer dashboard (data-subject, complaint and incident deadlines, anomalous access, processors, processing register, training, ERS register, retention), quarterly access review, per-patient «who accessed», complaint export for the ERS and data-subject export.
Pré-avaliação online3 operationsOnline assessment form, photos and submission (no session).
Recurso: 3D models7 operations3D models — module «ficha.captura»; clinical reads are audited.
Recurso: AI proposals7 operationsAI proposals — module «ficha.clinica»; clinical reads are audited.
Recurso: AI requests4 operationsAI requests — module «admin.definicoes».
Recurso: Absences and holidays7 operationsAbsences and holidays — module «agenda».
Recurso: Academy courses7 operationsAcademy courses — module «equipa.chat».
Recurso: Access alerts6 operationsAccess alerts — module «admin.auditoria».
Recurso: Access reviews6 operationsAccess reviews — module «admin.utilizadores».
Recurso: Ad audiences8 operationsAd audiences — module «marketing».
Recurso: Ad costs7 operationsAd costs — module «marketing».
Recurso: Agent requests5 operationsAgent requests — module «crm.agente».
Recurso: Agreement procedures7 operationsAgreement procedures — module «financeiro.pagamentos».
Recurso: Agreements7 operationsAgreements — module «financeiro.pagamentos».
Recurso: Announcements9 operationsAnnouncements — module «equipa.chat».
Recurso: Appointment types7 operationsAppointment types — module «agenda».
Recurso: Appointments11 operationsAppointments — module «agenda».
Recurso: Call lists10 operationsCall lists — module «crm.telefonia».
Recurso: Call scripts7 operationsCall scripts — module «crm.telefonia».
Recurso: Calls6 operationsCalls — module «crm.telefonia».
Recurso: Campaigns7 operationsCampaigns — module «marketing».
Recurso: Captures8 operationsCaptures — module «ficha.captura»; clinical reads are audited.
Recurso: Care by stage11 operationsCare by stage — module «acompanhamento».
Recurso: Certificates5 operationsCertificates — module «equipa.chat».
Recurso: Clinic numbers7 operationsClinic numbers — module «crm.telefonia».
Recurso: Clinical alerts9 operationsClinical alerts — module «ficha.clinica»; clinical reads are audited.
Recurso: Clinics6 operationsClinics — module «admin.definicoes».
Recurso: Commission rules7 operationsCommission rules — module «financeiro.valores».
Recurso: Commissions8 operationsCommissions — module «financeiro.valores».
Recurso: Complaints, compliments and suggestions10 operationsComplaints, compliments and suggestions — module «conformidade».
Recurso: Complementary treatments8 operationsComplementary treatments — module «acompanhamento»; clinical reads are audited.
Recurso: Complications8 operationsComplications — module «ficha.clinica»; clinical reads are audited.
Recurso: Consent register6 operationsConsent register — module «ficha.consentimentos».
Recurso: Consent templates10 operationsConsent templates — module «documentos».
Recurso: Consultations5 operationsConsultations — module «ficha.clinica»; clinical reads are audited.
Recurso: Contact opt-outs6 operationsContact opt-outs — module «conformidade».
Recurso: Conversations5 operationsConversations — module «crm.atendimento».
Recurso: Data subject requests12 operationsData subject requests — module «conformidade».
Recurso: Delegations8 operationsDelegations — module «admin.utilizadores».
Recurso: Discount codes7 operationsDiscount codes — module «comercial.descontos».
Recurso: Document templates11 operationsDocument templates — module «documentos».
Recurso: Eligibility rules10 operationsEligibility rules — module «clinico.parametros».
Recurso: Emergency access6 operationsEmergency access — module «admin.auditoria».
Recurso: Engine versions8 operationsEngine versions — module «clinico.parametros».
Recurso: Episode teams8 operationsEpisode teams — module «ficha.clinica».
Recurso: Episodes9 operationsEpisodes — module «ficha.clinica».
Recurso: Equipment8 operationsEquipment — module «conformidade».
Recurso: Extensions7 operationsExtensions — module «crm.telefonia».
Recurso: Fees7 operationsFees — module «financeiro.valores».
Recurso: Follow-up milestones10 operationsFollow-up milestones — module «acompanhamento»; clinical reads are audited.
Recurso: Form responses7 operationsForm responses — module «ficha.clinica»; clinical reads are audited.
Recurso: Forms11 operationsForms — module «ficha.clinica».
Recurso: Gift vouchers6 operationsGift vouchers — module «financeiro.pagamentos».
Recurso: Image library8 operationsImage library — module «marketing».
Recurso: Imports4 operationsImports — module «ficha.identificacao».
Recurso: Integration clients10 operationsIntegration clients — module «admin.definicoes».
Recurso: Issued documents7 operationsIssued documents — module «documentos».
Recurso: Items8 operationsItems — module «stock».
Recurso: Itineraries7 operationsItineraries — module «agenda».
Recurso: Knowledge base9 operationsKnowledge base — module «crm.agente».
Recurso: Leads11 operationsLeads — module «crm.leads».
Recurso: Lessons7 operationsLessons — module «equipa.chat».
Recurso: Locations7 operationsLocations — module «admin.definicoes».
Recurso: Maintenance and records7 operationsMaintenance and records — module «conformidade».
Recurso: Market funnels8 operationsMarket funnels — module «crm.leads».
Recurso: Meetings11 operationsMeetings — module «equipa.chat».
Recurso: Notices shown4 operationsNotices shown — module «conformidade».
Recurso: Online assessments8 operationsOnline assessments — module «crm.atendimento».
Recurso: Orders10 operationsOrders — module «stock».
Recurso: Partner referrals8 operationsPartner referrals — module «crm.leads».
Recurso: Partners11 operationsPartners — module «crm.leads».
Recurso: Patients11 operationsPatients — module «ficha.identificacao».
Recurso: Paying accounts7 operationsPaying accounts — module «financeiro.pagamentos».
Recurso: Payment terminals9 operationsPayment terminals — module «financeiro.pagamentos».
Recurso: Payments10 operationsPayments — module «financeiro.pagamentos».
Recurso: Photo protocols7 operationsPhoto protocols — module «ficha.captura».
Recurso: Photographs11 operationsPhotographs — module «ficha.fotografias»; clinical reads are audited.
Recurso: Pipeline stages7 operationsPipeline stages — module «crm.leads».
Recurso: Portal accounts8 operationsPortal accounts — module «ficha.identificacao».
Recurso: Portal requests8 operationsPortal requests — module «ficha.identificacao».
Recurso: Price lists8 operationsPrice lists — module «financeiro.pagamentos».
Recurso: Privacy notices9 operationsPrivacy notices — module «conformidade».
Recurso: Procedures7 operationsProcedures — module «financeiro.pagamentos».
Recurso: Processors7 operationsProcessors — module «conformidade».
Recurso: Profiles4 operationsProfiles — module «admin.utilizadores».
Recurso: Proposals5 operationsProposals — module «comercial.propostas».
Recurso: Public holidays7 operationsPublic holidays — module «agenda».
Recurso: Published cases7 operationsPublished cases — module «site.cms».
Recurso: Quick replies7 operationsQuick replies — module «crm.atendimento».
Recurso: Record of processing activities8 operationsRecord of processing activities — module «conformidade».
Recurso: Recorded messages7 operationsRecorded messages — module «crm.telefonia».
Recurso: Retention periods8 operationsRetention periods — module «conformidade».
Recurso: Rooms, equipment and interpreters7 operationsRooms, equipment and interpreters — module «agenda».
Recurso: Safety checklists7 operationsSafety checklists — module «bloco.registo».
Recurso: Sales goals7 operationsSales goals — module «crm.leads».
Recurso: Scheduled reports8 operationsScheduled reports — module «admin.definicoes».
Recurso: Security incidents10 operationsSecurity incidents — module «conformidade».
Recurso: Segments8 operationsSegments — module «marketing».
Recurso: Sequences7 operationsSequences — module «crm.leads».
Recurso: Special dates8 operationsSpecial dates — module «marketing».
Recurso: Stock movements5 operationsStock movements — module «stock».
Recurso: Sub-accounts7 operationsSub-accounts — module «financeiro.pagamentos».
Recurso: Supplier prices7 operationsSupplier prices — module «stock».
Recurso: Support diagnoses10 operationsSupport diagnoses — module «clinico.parametros».
Recurso: Surgeries4 operationsSurgeries — module «bloco.mapa».
Recurso: Surgical plans8 operationsSurgical plans — module «ficha.plano»; clinical reads are audited.
Recurso: Tasks9 operationsTasks — module «equipa.tarefas».
Recurso: Tax documents9 operationsTax documents — module «financeiro.pagamentos».
Recurso: Team training7 operationsTeam training — module «conformidade».
Recurso: Teams7 operationsTeams — module «admin.utilizadores».
Recurso: Teleconsultations4 operationsTeleconsultations — module «teleconsulta»; clinical reads are audited.
Recurso: Test conversations7 operationsTest conversations — module «crm.agente».
Recurso: Test questions7 operationsTest questions — module «equipa.chat».
Recurso: Tills4 operationsTills — module «financeiro.pagamentos».
Recurso: Training paths7 operationsTraining paths — module «equipa.chat».
Recurso: Trichoscopy fields7 operationsTrichoscopy fields — module «ficha.captura»; clinical reads are audited.
Recurso: Users11 operationsUsers — module «admin.utilizadores».
Recurso: Voice menus8 operationsVoice menus — module «crm.telefonia».
Recurso: Waiting list9 operationsWaiting list — module «agenda».
Recurso: Webhook deliveries5 operationsWebhook deliveries — module «admin.definicoes».
Recurso: Webhooks9 operationsWebhooks — module «admin.definicoes».
Recurso: Website blocks5 operationsWebsite blocks — module «site.cms».
Recurso: Website pages10 operationsWebsite pages — module «site.cms».
Recurso: WhatsApp lines8 operationsWhatsApp lines — module «admin.definicoes».
Recurso: Working hours7 operationsWorking hours — module «agenda».
Resultados de marketing6 operationsAd costs, cost per lead, consultation and surgery, and conversions for platforms.
Reuniões10 operationsInternal meetings recorded with notice and consent from everyone present: transcript by the clinic Assistant (local service first), summary and actions validated by a person. Team only.
Segurança da plataforma7 operationsReserved to platform management (403 for everyone else, including clinic administrators). Global infrastructure tables.
Sessão9 operationsWho am I, menu, clinics, notifications, search and emergency access.
Site — CMS10 operationsThe clinic website's pages, blocks, images, publishing and versions.
Site — analytics2 operationsAnonymous statistics and cookie decisions.
Site — incorporação2 operationsAssessment embedded in the clinic's authorised websites.
Site — pré-avaliações3 operationsMedical review and reply to online assessments.
Stock3 operationsConsumption per surgery (stock-outs with batch, linked to the surgery and patient) and minimum stock and expiry alerts.
Superadministradores6 operationsAccounts with access to the platform areas.
Tarefas12 operationsTeam tasks: mine, team, board by state, checklists, complete and reopen. Also for integrations (scope equipa.tarefas).
Teleconsulta18 operationsVirtual waiting room, consent before starting, admission, identity, attendees, recording only with its own consent, captures, mandatory report (with an optional Assistant draft) and attendance proof. Video through the video service chosen in Settings.
Terminais de pagamento6 operationsCharges on cloud terminals (SumUp Solo, Stripe Terminal): sending to the terminal, live status, cancellation and reconciliation with the till. The card is read on the terminal; nothing leaves outside production.
Tricoscopia5 operationsTrichoscopy fields with server-side densities, per-subzone averages and transfer to the plan.
Vales de oferta3 operationsSale of vouchers with a unique code, expiry and balance, lookup by code and full or partial use in payments. Multi-purpose (invoice on use) or single-purpose (invoice on sale).
Validação médica6 operationsSingle queue of items awaiting a professional decision: pending AI proposals, form responses awaiting validation, website pre-assessments, reported alerts and consultations awaiting signature — only for patients in clinical scope. Includes the AI performance review (agreement rate).
Visualizador 3D4 operationsShow a patient's 3D model inside your website, for a short time, without personal data.
1. In the integration credentials, request scope «ficha.captura:editar» (clinical module: requires the justification approved by the clinic's clinical director) and register your site ORIGINS (https://…).
2. `POST /modelos3d/{id}/incorporacao` returns `url` and `codigo_incorporacao` (iframe).
3. Paste the iframe in a page of one of the authorised origins: the response sends `Content-Security-Policy: frame-ancestors` with those origins only, so browsers refuse the frame on other sites.
The link lasts 5 to 240 minutes (clinic default), shows a clean copy of the mesh (face removed by default), counts each view and is recorded in the patient's audit trail. Revoke with `DELETE /modelos3d/incorporacoes/{id}`.