API reference

API Documentation

Safe public reference for 41 API feature endpoints. This page is informational only and lists approved web app API features, access levels, and sample request shapes.

Scope

This page documents what the official LTOP/MDMIP web app can request. It only lists safe API feature names, routes, access level, and example request shapes. Protected endpoints still require the correct signed-in account and permissions.

Access Levels

Public

Can be opened for availability checks.

Public form

Accepts validated form submissions from the official site.

Session

Requires a signed-in web session.

Customer

Requires the matching customer account.

Agent

Requires an approved agent account.

Employee

Requires an approved operations account.

Admin

Requires an approved administrator account.

Readiness and Support

Safe endpoints for checking availability and receiving customer support requests.

Method	Endpoint	Access	Feature
GET	/api/health	Public	Service availability check.
GET, POST	/api/customer-service	Public form	Customer support, complaint, and claims-assistance intake.
POST	/api/shares	Public form	Create a first-party share reference for approved sharing flows.

Registration and Account Access

Customer onboarding and account access APIs used by the official web app.

Method	Endpoint	Access	Feature
POST	/api/customer-registrations	Public form	Create a customer registration after validation.
POST	/api/auth/email-otp/request	Public form	Request a one-time email sign-in code.
POST	/api/auth/email-otp/verify	Public form	Verify a one-time email sign-in code.
POST	/api/auth/password-login	Public form	Sign in with an existing account.
GET, POST, DELETE	/api/auth/session	Session	Read, refresh, or clear the active web session.

Customer Features

Account, profile, application, document, payment, and claim features available to signed-in customers.

Method	Endpoint	Access	Feature
GET, POST, PATCH	/api/customer/dashboard	Customer	Load dashboard data and submit customer account updates.
POST	/api/customer/credits/transfer	Customer	Transfer eligible customer account credits.
GET, POST	/api/customer/export	Customer	Request or retrieve a customer data export.
GET, POST, DELETE	/api/documents	Session	Manage customer-uploaded document records.
GET	/api/documents/[id]/file	Session	Open an authorized document file.
GET, POST	/api/id-verifications	Session	Submit or review identity verification records.
GET, POST	/api/claims	Customer	Submit or list customer claims records.

Agent Features

Agent-facing APIs for assisted customer requests, referral links, and scoped client records.

Method	Endpoint	Access	Feature
GET, POST	/api/agent/clients	Agent	List assisted clients or create an assisted customer request.
PATCH, DELETE	/api/agent/clients/[id]	Agent	Update or cancel an assisted client record.
GET, POST	/api/referrals/invite	Session	Create or resolve an account-linked referral invitation.
GET, POST	/api/agents	Employee	List agent records or submit an agent registration record.
PATCH	/api/agents/[id]	Employee	Update approved agent profile details.
POST	/api/agents/assign	Employee	Assign or invite an agent through the official workflow.

Operations Features

Protected operations APIs for applications, policies, payments, announcements, reports, and account management.

Method	Endpoint	Access	Feature
GET, POST	/api/applications	Employee	List or create application records.
GET, PATCH	/api/applications/[id]	Employee	Read or update an application record.
POST	/api/applications/[id]/submit	Session	Submit an application for review.
POST	/api/applications/[id]/approve	Employee	Approve an application for the next step.
GET	/api/policies	Employee	List policy/request records.
PATCH, DELETE	/api/policies/[id]	Employee	Update or archive a policy record.
POST	/api/policies/[id]/approve	Employee	Approve a policy request.
POST	/api/policies/[id]/issue	Employee	Mark certificate issuance progress.
POST	/api/policies/[id]/activate	Employee	Activate a policy after required checks.
GET, POST	/api/payments	Employee	List or create payment records.
POST	/api/payments/[id]/confirm	Employee	Confirm a reviewed payment.
POST	/api/payments/[id]/reverse	Employee	Reverse a payment with an approved reason.
GET, POST, PATCH	/api/management/announcements	Employee	List, create, or update customer-facing announcements.
POST	/api/management/batch-encode	Employee	Batch encode validated customer profiles and assigned policy requests.
GET	/api/reports	Employee	Read available reports.
GET	/api/reports/daily	Employee	Generate daily report data.
GET	/api/reports/insured-enrollees	Employee	Generate the insurer enrollee workbook in the approved format.
PATCH	/api/users/[id]/roles	Admin	Update a user's allowed platform roles.

Checkout Features

Payment and receipt endpoints used by the official checkout surface.

Method	Endpoint	Access	Feature
POST	/api/checkout/qrph	Session	Create a checkout request for an approved payment purpose.
GET, PATCH	/api/checkout/status	Session	Read or update checkout status.

Safe Request Examples

Support intake

POST /api/customer-service

{
  "name": "Juan Dela Cruz",
  "contact": "+639171234567 or juan@example.com",
  "topic": "Support concern",
  "referenceNo": "Optional account or payment reference",
  "message": "Describe the concern and requested help."
}

Batch encode

POST /api/management/batch-encode

{
  "agentEmail": "agent@example.com",
  "customers": [
    {
      "firstName": "Juan",
      "lastName": "Dela Cruz",
      "middleInitial": "S",
      "birthDate": "1986-03-14",
      "mobileNumber": "+639171234567",
      "email": "juan.delacruz@example.com",
      "address": "Quezon City, Metro Manila",
      "occupation": "Transport Driver",
      "beneficiaries": [
        { "name": "Maria Dela Cruz", "relationship": "Spouse" }
      ]
    }
  ]
}

Checkout request

POST /api/checkout/qrph

{
  "amount": 1825,
  "purpose": "policy",
  "policyId": "policy_document_id",
  "returnTo": "/customer/dashboard?section=payments",
  "tierKey": "single"
}

Role update

PATCH /api/users/[id]/roles

{
  "reason": "Approved role update.",
  "roles": ["customer", "agent"]
}

API reference

API Documentation

Safe public reference for 41 API feature endpoints. This page is informational only and lists approved web app API features, access levels, and sample request shapes.

Scope

Access Levels

Public

Can be opened for availability checks.

Public form

Accepts validated form submissions from the official site.

Session

Requires a signed-in web session.

Customer

Requires the matching customer account.

Agent

Requires an approved agent account.

Employee

Requires an approved operations account.

Admin

Requires an approved administrator account.

Readiness and Support

Safe endpoints for checking availability and receiving customer support requests.

Method	Endpoint	Access	Feature
GET	/api/health	Public	Service availability check.
GET, POST	/api/customer-service	Public form	Customer support, complaint, and claims-assistance intake.
POST	/api/shares	Public form	Create a first-party share reference for approved sharing flows.

Registration and Account Access

Customer onboarding and account access APIs used by the official web app.

Method	Endpoint	Access	Feature
POST	/api/customer-registrations	Public form	Create a customer registration after validation.
POST	/api/auth/email-otp/request	Public form	Request a one-time email sign-in code.
POST	/api/auth/email-otp/verify	Public form	Verify a one-time email sign-in code.
POST	/api/auth/password-login	Public form	Sign in with an existing account.
GET, POST, DELETE	/api/auth/session	Session	Read, refresh, or clear the active web session.

Customer Features

Account, profile, application, document, payment, and claim features available to signed-in customers.

Method	Endpoint	Access	Feature
GET, POST, PATCH	/api/customer/dashboard	Customer	Load dashboard data and submit customer account updates.
POST	/api/customer/credits/transfer	Customer	Transfer eligible customer account credits.
GET, POST	/api/customer/export	Customer	Request or retrieve a customer data export.
GET, POST, DELETE	/api/documents	Session	Manage customer-uploaded document records.
GET	/api/documents/[id]/file	Session	Open an authorized document file.
GET, POST	/api/id-verifications	Session	Submit or review identity verification records.
GET, POST	/api/claims	Customer	Submit or list customer claims records.

Agent Features

Agent-facing APIs for assisted customer requests, referral links, and scoped client records.

Method	Endpoint	Access	Feature
GET, POST	/api/agent/clients	Agent	List assisted clients or create an assisted customer request.
PATCH, DELETE	/api/agent/clients/[id]	Agent	Update or cancel an assisted client record.
GET, POST	/api/referrals/invite	Session	Create or resolve an account-linked referral invitation.
GET, POST	/api/agents	Employee	List agent records or submit an agent registration record.
PATCH	/api/agents/[id]	Employee	Update approved agent profile details.
POST	/api/agents/assign	Employee	Assign or invite an agent through the official workflow.

Operations Features

Protected operations APIs for applications, policies, payments, announcements, reports, and account management.

Method	Endpoint	Access	Feature
GET, POST	/api/applications	Employee	List or create application records.
GET, PATCH	/api/applications/[id]	Employee	Read or update an application record.
POST	/api/applications/[id]/submit	Session	Submit an application for review.
POST	/api/applications/[id]/approve	Employee	Approve an application for the next step.
GET	/api/policies	Employee	List policy/request records.
PATCH, DELETE	/api/policies/[id]	Employee	Update or archive a policy record.
POST	/api/policies/[id]/approve	Employee	Approve a policy request.
POST	/api/policies/[id]/issue	Employee	Mark certificate issuance progress.
POST	/api/policies/[id]/activate	Employee	Activate a policy after required checks.
GET, POST	/api/payments	Employee	List or create payment records.
POST	/api/payments/[id]/confirm	Employee	Confirm a reviewed payment.
POST	/api/payments/[id]/reverse	Employee	Reverse a payment with an approved reason.
GET, POST, PATCH	/api/management/announcements	Employee	List, create, or update customer-facing announcements.
POST	/api/management/batch-encode	Employee	Batch encode validated customer profiles and assigned policy requests.
GET	/api/reports	Employee	Read available reports.
GET	/api/reports/daily	Employee	Generate daily report data.
GET	/api/reports/insured-enrollees	Employee	Generate the insurer enrollee workbook in the approved format.
PATCH	/api/users/[id]/roles	Admin	Update a user's allowed platform roles.

Checkout Features

Payment and receipt endpoints used by the official checkout surface.

Method	Endpoint	Access	Feature
POST	/api/checkout/qrph	Session	Create a checkout request for an approved payment purpose.
GET, PATCH	/api/checkout/status	Session	Read or update checkout status.

Safe Request Examples

Support intake

POST /api/customer-service

{
  "name": "Juan Dela Cruz",
  "contact": "+639171234567 or juan@example.com",
  "topic": "Support concern",
  "referenceNo": "Optional account or payment reference",
  "message": "Describe the concern and requested help."
}

Batch encode

POST /api/management/batch-encode

{
  "agentEmail": "agent@example.com",
  "customers": [
    {
      "firstName": "Juan",
      "lastName": "Dela Cruz",
      "middleInitial": "S",
      "birthDate": "1986-03-14",
      "mobileNumber": "+639171234567",
      "email": "juan.delacruz@example.com",
      "address": "Quezon City, Metro Manila",
      "occupation": "Transport Driver",
      "beneficiaries": [
        { "name": "Maria Dela Cruz", "relationship": "Spouse" }
      ]
    }
  ]
}

Checkout request

POST /api/checkout/qrph

{
  "amount": 1825,
  "purpose": "policy",
  "policyId": "policy_document_id",
  "returnTo": "/customer/dashboard?section=payments",
  "tierKey": "single"
}

Role update

PATCH /api/users/[id]/roles

{
  "reason": "Approved role update.",
  "roles": ["customer", "agent"]
}