Patient Portal API

The public, patient-facing API for Yakap MS. A patient signs in with their PhilHealth PIN and a password, then reads their own consultations, lab results, dental treatments, prescriptions and Konsulta benefit balances. Built for native mobile clients.

Getting started

Every endpoint lives under /api/public/portal. Sign in once to get an access token, then send it as Authorization: Bearer {token} on every request. There is no Sanctum session and no CSRF token — the whole surface is designed to be reachable from a native app.

Three things to get right before writing much code:

  • Bearer, not cookies. The token comes back as data.token on login and is valid for 7 days. There is no refresh endpoint — on 401, sign in again.
  • 10 requests per minute, per IP, shared across the entire public surface. Load lazily, per screen.
  • 404 is not 401. A patient registered by the clinic has no registration record, so registration endpoints return 404 for them. Hide the feature; don't sign them out.

Guides

Overview & Auth

Bearer tokens, the two kinds of patient session, rate limiting and error semantics.

Read more

Medical Records

Consultations, laboratory results, dental treatments, prescriptions and Konsulta balances.

Read more

Documents & Images

Visit summary PDFs, ID photos and PCU results — the endpoints that return binary data.

Read more

Registration

Public self-registration, membership checks and the self-reported health questionnaire.

Read more

Endpoints

Overview & Auth

Sign in, read the session, sign out. Bearer tokens, session kinds, rate limits and error semantics.

Medical Records

Consultations, laboratory results, dental treatments, prescriptions and Konsulta benefit balances.

Documents & Images

Visit summary PDFs, registration summaries, QR tokens and uploaded ID photos.

Registration

Public self-registration, Konsulta membership checks and the self-reported health questionnaire.

Was this page helpful?