{"info":{"_postman_id":"5cc02e3b-8ad9-4be7-bfe9-8ec877008f03","name":"CAMBRIDGE OPENAPI","description":"

Changelogs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Date	Description	Version
Aug 2026	V3 - Void a Case. Cancels a case that has not yet had its guarantee letter released; retrying against an already-voided case succeeds as a no-op.	3.2.0
Aug 2026	V3 - Price Eligibility. Checks whether an amount is covered before a case exists. Binary in money terms; never discloses the member's remaining limit or visit count.	3.1.0
May 2026	V3 - New multi-tenant API: OAuth client credentials, Cases Search, Get Case Detail, Create Case, Validate Outpatient Billing, Release Guarantee Letter, Member Eligibility, Member Search, Get Member Detail.	3.0.0
Oct 2025	New API for submitting claim history, improved performance.	2.7.0
Feb 2025	Changed the Find By Card Number response structure, added an endpoint for retrieving a member's benefit, updated the staging base URL.	2.6.1
Jan 2025	List Member by Client Code, and Provider List filtering by distance.	2.5.3
Oct 2024	Claim, Member's Data and Provider List.	2.4.4
Aug 2024	Enrollment Process.	1.0.0

Overview

Cambridge OpenAPI is the integration surface for HealthMetrics Indonesia. It lets our clients and partners enrol members, manage policies, submit and track claims, and look up providers, without integrating directly against our internal enrolment system.

Cambridge enriches each request with the internal data you do not need to know about, forwards it to the HealthMetrics Indonesia enrolment and claim services, and returns the result to you.

Which version do I use?

There are two generations of this API, and they are documented separately in the sidebar.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	V1 & V2	V3
Model	Single-tenant proxy	First-party multi-tenant system
Authentication	Client key + server key exchanged for a bearer token	OAuth client credentials
Authorisation	Scoped to your client	Per-permission (`cases:read`, `members:search`, ...) plus tenant data bindings
Response shapes	Four different families	One consistent envelope
Base path	`<host>/v1/api/...` or `<host>/v2/api/...`	`<host>/v3/api/...`
Status	Supported for existing partners	Recommended for new integrations

Starting a new integration? Use V3. It has consistent responses, finer-grained permissions and clearer errors. V1 and V2 remain fully supported - nothing is being switched off - but they carry historical inconsistencies that V3 does not.

Each version's folder in the sidebar opens with its own conventions page. Read that page before writing any code against it; it covers response shapes, error bodies and status codes, which differ between the two.

Business flow

The flows below describe the enrolment lifecycle, which is common to both versions. Endpoint names are given for V1 and V2; the V3 equivalents are in the V3 folder.

Enrolment

The member enrolment flow starts once our team has finished setting up the plans and benefits. You then use the Enroll endpoint to create a member with Principal status.

To enrol a dependant, create the principal first. You can then enrol the dependant with Enroll-Member, setting the principal's member number on the request. Use the same endpoint to correct a member's details, such as a date of birth.

\n $\"Enrollment$ \n\n

Effective date and renewal

To correct the dates on a member's current policy, use Enroll-Update-Effective. To extend cover into a new term, use Enroll-Renewal.

\n $\"Update$ \n\n

Change plan

If a member moves to a different plan, whether an upgrade or a downgrade, use Enroll-Change-Plan.

\n $\"Change$ \n\n

Terminate and suspend

To end cover, use Terminate. To take it out of force temporarily, use Suspend.

These two have different reversals, and mixing them up is the most common enrolment mistake:

Suspend is reversed by Reinstate
Terminate is reversed by ReActivate

\n $\"Terminate$ \n\n

Re-activate

For a terminated member, ReActivate re-enrols them.

\n $\"Reactive$ \n\n

Claims

List a member's claims with GetListClaim, and read one in full with GetDataClaim. Guarantee letters are available as PDFs from DownloadIGL and DownloadFGL.

For cashless treatment, check eligibility with ValidationCashless first, then submit with SubmitClaimCashless. For reimbursement, submit with SubmitClaim and attach the receipts with Upload.

In V3 the equivalent sequence is Member Eligibility, Price Eligibility, Create Case, Validate Outpatient Billing and Release Guarantee Letter.

Members and providers

Look up a member by card number with FindByCardNumber, and their plans and limits with GetBenefitsByCardNumber. List a client's members with ListMemberByClientCode, or across corporates with ListByCorporateCode.

ListProviderFacility returns the panel a member can use, and can be filtered by distance from a coordinate.

Features

RESTful and straightforward to integrate. Predictable resources, standard HTTP verbs and status codes.
Full enrolment lifecycle. Principal and dependant enrolment, updates, plan changes, renewals, suspension, reinstatement, termination and re-activation - individually or in bulk.
Claims end to end. Cashless and reimbursement submission, document upload, status tracking, guarantee letter retrieval and historical claim loading.
Member and provider lookup. Benefits, limits, family members and the eligible provider panel.
Two integration generations. V1 and V2 for existing partners, V3 for new ones.

Setting Up

Request access. Contact your HealthMetrics Indonesia representative. We set up your plans and benefits before enrolment can begin.
Receive your credentials. For V1 and V2 you receive a client key and server key. For V3 you receive an API client ID and client secret, along with the permissions your integration needs.
Choose an environment. You are given a staging host first. Production access follows once your integration has been verified.
Configure your environment variables. Every request in this collection reads its host and credentials from variables - no credential is stored in this documentation.
Authenticate, then call. See Authorization below.

Credentials are issued per integration and per environment. Staging credentials do not work against production.

Reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Terminology	Description
Principal	The member who holds the policy. Also written Principle in some payloads.
Dependant	A member covered under a principal's policy, such as a spouse or child.
GL	Guarantee Letter. The document confirming cover for a claim.
IGL	Initial Guarantee Letter, issued when a case is registered.
FGL	Final Guarantee Letter, issued when a case is settled.
Cashless	The provider bills HealthMetrics directly; the member does not pay up front.
Reimbursement	The member pays, then claims the cost back.
Corporate	The employer whose staff are covered.
Client	The insurer or scheme owner whose book the members belong to.
Tenant (V3)	The organisation an API client acts for, with data bindings limiting what it can see.

Authorization

Both versions use HTTP bearer tokens, but they are obtained differently and the tokens are not interchangeable.

V1 & V2 - client key and server key

Exchange your keys for a token:

POST <host>/v1/api/Auth/Login\n\n{\n  \"clientKey\": \"your-client-key\",\n  \"serverKey\": \"your-server-key\"\n}\n

Send the returned token on every other request:

Authorization: Bearer <token>\n

Login reports failure with HTTP 200. A wrong key does not return a 4xx - it returns 200 with data as the string \"Not Found\" instead of an object. Check the type of data before using it.

V3 - OAuth client credentials

POST <host>/v3/api/oauth/token\n\n{\n  \"grant_type\": \"client_credentials\",\n  \"client_id\": \"your-client-id\",\n  \"client_secret\": \"your-client-secret\"\n}\n

The access token lasts 60 minutes. There is no refresh endpoint - request a new token. The token carries your permissions and data bindings as they stood when it was issued, so a permission change takes effect on your next token, not the current one.

Send it the same way:

Authorization: Bearer <access_token>\n

Keeping credentials safe

Your keys authenticate as you. Treat them as passwords:

Store them in environment variables or a secret manager - never in source control, a shared document or a Postman collection.
Use separate credentials per environment.
Ask us to rotate them if they may have been exposed.

Every example in this documentation uses placeholders such as {{clientkey}}. No real credential, member, card or claim number appears anywhere in it.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Changelogs","slug":"changelogs"},{"content":"Overview","slug":"overview"},{"content":"Business flow","slug":"business-flow"},{"content":"Features","slug":"features"},{"content":"Setting Up","slug":"setting-up"},{"content":"Reference","slug":"reference"},{"content":"Authorization","slug":"authorization"}],"owner":"37286085","collectionId":"5cc02e3b-8ad9-4be7-bfe9-8ec877008f03","publishedId":"2sA3s1nBVi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"199BB6"},"publishDate":"2024-08-09T08:58:36.000Z"},"item":[{"name":"Cambridge API","item":[{"name":"V1 & V2","item":[{"name":"Authorization","item":[{"name":"Login","event":[{"listen":"test","script":{"type":"text/javascript","exec":["// Store the bearer token for every other request in this folder.","// Login reports failure as HTTP 200 with data as a string, so check the type.","if (pm.response.code === 200) {"," const res = pm.response.json();"," if (res.data && typeof res.data === 'object' && res.data.token) {"," pm.collectionVariables.set(\"BearerToken\", res.data.token);"," } else {"," console.warn('Login did not return a token:', res.data);"," }","}"]}}],"id":"4485b944-f6c9-42f7-ac73-27dad496aebb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"accept","value":"text/plain"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientKey\": \"{{clientkey}}\",\n \"serverKey\": \"{{serverkey}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Auth/Login","description":"

Exchange your client key and server key for a bearer token.

POST {{base}}/api/Auth/Login

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	None - this is the only unauthenticated endpoint
Versions	v1 and v2
Content-Type	`application/json`

Description

The only way to obtain a token. The token embeds the NOVA client identity resolved from your keys, so it is scoped to your client's book. Read expiry and re-authenticate before then - there is no refresh endpoint.

This request's post-response script writes the token into BearerToken, which every other request in this folder inherits.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Description
`clientKey`	string	Yes	Identifies the integration. Issued to you.
`serverKey`	string	Yes	Authenticates the integration. Issued to you.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Either a token or a failure - see the warning below.

Response fields - `data`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`token`	string(jwt)	No	Send as `Authorization: Bearer <token>`.
`tokenType`	string	No	`Bearer`.
`expiry`	string(date-time)	No	When the token stops working.
`timezone`	string	Yes	Timezone the expiry is expressed in.
`duration`	string	Yes	Human-readable lifetime.

A wrong client key or server key does not return 4xx. It returns 200 with data as a string:

{ \"data\": \"Not Found\" }\n

Check the type of data before using it. Treating any 200 as success will silently give your integration no token.

\n","urlObject":{"path":["{{apiVersion}}","api","Auth","Login"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"14dd6451-e59b-46e5-9d4a-ad27b4da5560","name":"Token issued","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"accept","value":"text/plain"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientKey\": \"{{clientkey}}\",\n \"serverKey\": \"{{serverkey}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Auth/Login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.\",\n \"tokenType\": \"Bearer\",\n \"expiry\": \"2026-01-01T12:00:00Z\",\n \"timezone\": \"Asia/Jakarta\",\n \"duration\": \"60 minutes\"\n }\n}"},{"id":"2047a14a-e7c2-4367-a252-0a9590528d5b","name":"Bad credentials - note HTTP 200","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"accept","value":"text/plain"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientKey\": \"{{clientkey}}\",\n \"serverKey\": \"{{serverkey}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Auth/Login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": \"Not Found\"\n}"}],"_postman_id":"4485b944-f6c9-42f7-ac73-27dad496aebb"}],"id":"bd949d32-b1a3-4cf6-b772-c7d61d812c9a","description":"

Exchange your client key and server key for a bearer token.

Run Login first. Its post-response script stores the token in BearerToken, which every other request in this folder inherits.

Login reports failure as HTTP 200 with {\"data\": \"Not Found\"} - check that data is an object, not a string.

\n","_postman_id":"bd949d32-b1a3-4cf6-b772-c7d61d812c9a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"523f522d-2941-42db-a086-102b1051e12d","id":"523f522d-2941-42db-a086-102b1051e12d","name":"V1 & V2","type":"folder"}}},{"name":"Enrollment","item":[{"name":"Enrollment New Member","item":[{"name":"Enrollment New Member","id":"5cf3cc2b-29bc-4e04-b17a-91b2c7f3019d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"New member enrolment\",\n \"member\": {\n \"memberNumber\": \"MEM00000001\",\n \"name\": \"John Doe\",\n \"sex\": \"M\",\n \"maritalStatus\": \"S\",\n \"dateOfBirth\": \"1990-01-01\",\n \"planDescription\": \"Sample Inpatient Plan\",\n \"bankCode\": \"\",\n \"memberType\": \"\",\n \"phoneNumber\": \"+628000000001\",\n \"principal\": null\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2026-01-01\",\n \"endDate\": \"2026-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-001\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/Enroll","description":"

Create a member and their policy in one call.

POST {{base}}/api/Member/Enroll

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Success	`201 Created`

Description

Creates the member record and puts the policy in force. The principal must exist before any dependant can be enrolled against them - enrol the principal first, then set member.principal on the dependant's call.

If the member already holds this policy the call is refused with MemberAndPolicyExist; use Update Member Data (PUT Enroll-Member) to change their plan instead.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	In	Type	Format	Req.	Description
`corporateCode`	body	string	-	Yes	The corporate the member belongs to.
`actionDescription`	body	string	-	Yes	Free-text reason, stored on the downstream audit trail.
`member`	body	object	-	Yes	Member details - see below.
`policy`	body	object	-	Yes	Policy details - see below.

member

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Format	Req.	Description
`memberNumber`	string	-	Yes	Your identifier for the member.
`name`	string	-	Yes	Full name.
`sex`	string	-	Yes	`M` / `F`.
`maritalStatus`	string	-	Yes	`S` / `M`.
`dateOfBirth`	string	`yyyy-MM-dd`	Yes	Date of birth.
`planDescription`	string	-	No	Free-text plan label.
`bankCode`	string	-	No	Bank code for reimbursement.
`memberType`	string	-	No	Member type.
`phoneNumber`	string	-	No	Mobile number.
`principal`	object	-	No	Required for a dependant. `{ memberNumber, relationship }`.

policy

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Format	Req.	Description
`policyNumber`	string	-	Yes	Policy number.
`startDate`	string	`yyyy-MM-dd`	Yes	Policy start.
`endDate`	string	`yyyy-MM-dd`	Yes	Policy end.
`plans`	array	-	No	`[{ planCode, isActive }]`. `isActive` is optional.
`remarks`	string	-	No	Free-text remarks.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`201`	Member and policy created.
`400`	Member already holds this policy, or a field failed validation.
`401`	Missing or expired token.

Response fields - `data[]`

Every enrolment endpoint returns the same array of member records. All are always present.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`memberNumber`	string	No	Your member identifier, as supplied.
`memberPrincipalNumber`	string	Yes	The principal's member number. `null` for a principal.
`name`	string	No	Member name.
`phoneNumber`	string	Yes	Mobile number.
`dateOfBirth`	string	No	`yyyy-MM-dd`.
`memberStatus`	string	No	e.g. `ACTIVE`, `SUSPEND`, `TERMINATE`.
`familyStatus`	string	No	e.g. `Principle`, `Spouse`, `Child`.
`policyNumber`	string	No	Policy the record belongs to.
`planCode`	string[]	No	Plan codes on the policy. Split from a semicolon-delimited downstream value, so an empty policy yields `[]`.

The array contains the member you acted on and any family members affected by the same change.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	ErrorCode	Message
400	`MemberAndPolicyExist`	Policy for this member already exist. To update the plan, please use PUT method instead.
400	`MemberOrPolicyNotExist`	Policy for this member not exist.
400	(RFC 7807)	A required field was missing or mistyped - see `errors`.
401	-	Missing or expired token. Empty body.

","urlObject":{"path":["{{apiVersion}}","api","Member","Enroll"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"1c64259d-6ef7-4dfb-bf8a-b629b17937bb","name":"Member created","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"New member enrolment\",\n \"member\": {\n \"memberNumber\": \"MEM00000001\",\n \"name\": \"John Doe\",\n \"sex\": \"M\",\n \"maritalStatus\": \"S\",\n \"dateOfBirth\": \"1990-01-01\",\n \"planDescription\": \"Sample Inpatient Plan\",\n \"bankCode\": \"\",\n \"memberType\": \"\",\n \"phoneNumber\": \"+628000000001\",\n \"principal\": null\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2026-01-01\",\n \"endDate\": \"2026-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-001\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"memberNumber\": \"MEM00000001\",\n \"memberPrincipalNumber\": null,\n \"name\": \"John Doe\",\n \"phoneNumber\": \"+628000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"memberStatus\": \"ACTIVE\",\n \"familyStatus\": \"Principle\",\n \"policyNumber\": \"POL0000000000001\",\n \"planCode\": [\n \"PLAN-001\"\n ]\n }\n ]\n}"},{"id":"d7a26ad9-3e75-4f2c-910d-9f6291b36402","name":"Member already holds this policy","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"New member enrolment\",\n \"member\": {\n \"memberNumber\": \"MEM00000001\",\n \"name\": \"John Doe\",\n \"sex\": \"M\",\n \"maritalStatus\": \"S\",\n \"dateOfBirth\": \"1990-01-01\",\n \"planDescription\": \"Sample Inpatient Plan\",\n \"bankCode\": \"\",\n \"memberType\": \"\",\n \"phoneNumber\": \"+628000000001\",\n \"principal\": null\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2026-01-01\",\n \"endDate\": \"2026-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-001\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"MemberAndPolicyExist\",\n \"Message\": \"Policy for this member already exist. To update the plan, please use PUT method instead.\"\n }\n ]\n}"},{"id":"0ec777e7-9020-4047-ba75-6287611fc821","name":"Validation failure","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"New member enrolment\",\n \"member\": {\n \"memberNumber\": \"MEM00000001\",\n \"name\": \"John Doe\",\n \"sex\": \"M\",\n \"maritalStatus\": \"S\",\n \"dateOfBirth\": \"1990-01-01\",\n \"planDescription\": \"Sample Inpatient Plan\",\n \"bankCode\": \"\",\n \"memberType\": \"\",\n \"phoneNumber\": \"+628000000001\",\n \"principal\": null\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2026-01-01\",\n \"endDate\": \"2026-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-001\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"errors\": {\n \"cardNumber\": [\n \"The cardNumber field is required.\"\n ]\n },\n \"traceId\": \"00-00000000000000000000000000000000-0000000000000000-00\"\n}"}],"_postman_id":"5cf3cc2b-29bc-4e04-b17a-91b2c7f3019d"},{"name":"Get Enrollment","id":"cd235466-4c96-4a7e-8ee1-6458cd0b70f3","request":{"method":"GET","header":[],"url":"{{base}}/{{apiVersion}}/api/Member/Enroll/:memberId/:policyNumber/:corporateCode","description":"

Read a single enrolment by member, policy and corporate.

GET {{base}}/api/Member/Enroll/{memberId}/{policyNumber}/{corporateCode}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Success	`200 OK`

Description

The read counterpart to the enrolment write endpoints, returning the same member-record shape they do. Use it to confirm a change landed.

All three path segments are required - the member is identified by the combination, not by member number alone.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	In	Type	Req.	Description
`memberId`	path	string	Yes	Your identifier for the member.
`policyNumber`	path	string	Yes	Policy number.
`corporateCode`	path	string	Yes	The corporate the member belongs to.
`Authorization`	header	string	Yes	`Bearer <token>`.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	The enrolment.
`400`	No such member - `MemberOrPolicyNotExist`.
`401`	Missing or expired token.

Response fields - `data[]`

Every enrolment endpoint returns the same array of member records. All are always present.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`memberNumber`	string	No	Your member identifier, as supplied.
`memberPrincipalNumber`	string	Yes	The principal's member number. `null` for a principal.
`name`	string	No	Member name.
`phoneNumber`	string	Yes	Mobile number.
`dateOfBirth`	string	No	`yyyy-MM-dd`.
`memberStatus`	string	No	e.g. `ACTIVE`, `SUSPEND`, `TERMINATE`.
`familyStatus`	string	No	e.g. `Principle`, `Spouse`, `Child`.
`policyNumber`	string	No	Policy the record belongs to.
`planCode`	string[]	No	Plan codes on the policy. Split from a semicolon-delimited downstream value, so an empty policy yields `[]`.

The array contains the member you acted on and any family members affected by the same change.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f38d01cc-adfb-44f5-a45e-4f9ad7231348","id":"f38d01cc-adfb-44f5-a45e-4f9ad7231348","name":"Enrollment New Member","type":"folder"}},"urlObject":{"path":["{{apiVersion}}","api","Member","Enroll",":memberId",":policyNumber",":corporateCode"],"host":["{{base}}"],"query":[],"variable":[{"description":{"content":"

Your identifier for the member.

\n","type":"text/plain"},"type":"any","value":"MEM00000001","key":"memberId"},{"description":{"content":"

Policy number.

\n","type":"text/plain"},"type":"any","value":"POL0000000000001","key":"policyNumber"},{"description":{"content":"

The corporate the member belongs to.

\n","type":"text/plain"},"type":"any","value":"CORP01","key":"corporateCode"}]}},"response":[{"id":"30118172-ca16-4ae1-b58d-49cac2ae765b","name":"The enrolment","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base}}/api/Member/Enroll/:memberId/:policyNumber/:corporateCode","host":["{{base}}"],"path":["api","Member","Enroll",":memberId",":policyNumber",":corporateCode"],"variable":[{"key":"memberId","value":"MEM00000001","description":"Your identifier for the member."},{"key":"policyNumber","value":"POL0000000000001","description":"Policy number."},{"key":"corporateCode","value":"CORP01","description":"The corporate the member belongs to."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"memberNumber\": \"MEM00000001\",\n \"memberPrincipalNumber\": null,\n \"name\": \"John Doe\",\n \"phoneNumber\": \"+628000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"memberStatus\": \"ACTIVE\",\n \"familyStatus\": \"Principle\",\n \"policyNumber\": \"POL0000000000001\",\n \"planCode\": [\n \"PLAN-001\"\n ]\n }\n ]\n}"},{"id":"794e77e6-a941-48dd-bb31-e76c26436dde","name":"No such member or policy","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base}}/api/Member/Enroll/:memberId/:policyNumber/:corporateCode","host":["{{base}}"],"path":["api","Member","Enroll",":memberId",":policyNumber",":corporateCode"],"variable":[{"key":"memberId","value":"MEM00000001","description":"Your identifier for the member."},{"key":"policyNumber","value":"POL0000000000001","description":"Policy number."},{"key":"corporateCode","value":"CORP01","description":"The corporate the member belongs to."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"MemberOrPolicyNotExist\",\n \"Message\": \"Policy for this member not exist.\"\n }\n ]\n}"}],"_postman_id":"cd235466-4c96-4a7e-8ee1-6458cd0b70f3"}],"id":"f38d01cc-adfb-44f5-a45e-4f9ad7231348","description":"

Create a member and their policy in one call. Returns 201.

The principal must exist before any dependant can be enrolled against them.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"07775f73-ec37-4774-9a3a-4e39fe6ff1ba","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"cdb91178-a237-4dc0-bf0e-98b451ace8a1","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"f38d01cc-adfb-44f5-a45e-4f9ad7231348"},{"name":"Bulk Enrollment New Member","item":[{"name":"Bulk Enrollment New Member","id":"27b3515c-6c29-4b84-934c-670780e60af1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"RecordMode\": 1,\n \"RecordType\": \"N\",\n \"PayorID\": \"CLI01\",\n \"MemberID\": \"MEM00000001\",\n \"MappingID\": \"\",\n \"CardNumber\": \"9999000000000001\",\n \"CorporateEmail\": \"hr@example.com\",\n \"TpaMemberID\": \"\",\n \"CorporateID\": \"CORP01\",\n \"Nik\": \"0000000000000001\",\n \"Division\": \"\",\n \"BranchCode\": \"\",\n \"BankInfo\": \"\",\n \"Language\": \"id-id\",\n \"TypeOfWork\": 1,\n \"Race\": \"\",\n \"PolicyNumber\": \"POL0000000000001\",\n \"MaritalStatus\": \"S\",\n \"Relationship\": \"Principle\",\n \"MembersEffectiveDate\": \"2026-01-01\",\n \"MembersExpiryDate\": \"2026-12-31\",\n \"FaskesFKTP\": \"\",\n \"FaskesFKRTL\": \"\",\n \"ClassesBPJS\": \"\",\n \"NameOfFaskes\": \"\",\n \"RuleBPJSK\": \"\",\n \"MemberName\": \"John Doe\",\n \"Address1\": \"1 Sample Street\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"City\": \"Jakarta\",\n \"State\": \"DKI Jakarta\",\n \"PostCode\": \"10000\",\n \"TelephoneMobile\": \"+628000000001\",\n \"TelephoneRes\": \"\",\n \"TelephoneOffice\": \"\",\n \"NRIC\": \"\",\n \"PassportNo\": \"A0000001\",\n \"PassportCountry\": \"ID\",\n \"Email\": \"john.doe@example.com\",\n \"IdentificationCode\": \"\",\n \"DateOfBirth\": \"1990-01-01\",\n \"Sex\": \"M\",\n \"PlanID\": \"PLAN-001\",\n \"EmploymentStatus\": \"\",\n \"DateTerminated\": \"\",\n \"PreExisting\": \"\",\n \"BpjsID\": \"\",\n \"EndorsementDate\": \"\",\n \"Remarks\": \"\",\n \"MemberSince\": \"2026-01-01\",\n \"PolicyInForce\": \"1\",\n \"MemberSuspended\": \"0\",\n \"ActivationDate\": \"2026-01-01\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/Enroll-Member-Bulk","description":"

Bulk enrol members using the original NOVA-style record.

POST {{base}}/api/Member/Enroll-Member-Bulk

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Success	`200 OK`

Description

Takes an array of flat enrolment records, 55 fields each. This is the original bulk format and includes Indonesian statutory fields - FaskesFKTP, FaskesFKRTL, ClassesBPJS, RuleBPJSK, BpjsID.

Both bulk endpoints are live. Use New-Enroll-Member-Bulk if your integration was set up against the product-based format; the two records are not interchangeable.

Request body - array item

Required fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`RecordMode`	integer	Operation selector for the row.
`RecordType`	string	Record type.
`PayorID`	string	Payor identifier.
`MemberID`	string	Your identifier for the member.
`CorporateID`	string	Corporate identifier.
`PolicyNumber`	string	Policy number.
`Relationship`	string	Relationship to the principal.
`MemberName`	string	Full name.
`TelephoneMobile`	string	Mobile number.
`PassportNo`	string	Passport number.
`Sex`	string	`M` / `F`.
`PlanID`	string	Plan identifier.

Optional fields: MappingID, CardNumber, CorporateEmail, TpaMemberID, Nik, Division, BranchCode, BankInfo, Language, TypeOfWork, Race, MaritalStatus, MembersEffectiveDate, MembersExpiryDate, FaskesFKTP, FaskesFKRTL, ClassesBPJS, NameOfFaskes, RuleBPJSK, Address1-Address4, City, State, PostCode, TelephoneRes, TelephoneOffice, NRIC, PassportCountry, Email, IdentificationCode, DateOfBirth, EmploymentStatus, DateTerminated, PreExisting, BpjsID, EndorsementDate, Remarks, MemberSince, PolicyInForce, MemberSuspended, ActivationDate.

Dates in this payload are strings with no enforced format. Follow the template supplied with your onboarding pack rather than assuming yyyy-MM-dd.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Batch accepted. Per-row outcomes are in the response body.
`400`	The array was empty or a row failed validation.
`401`	Missing or expired token.

","urlObject":{"path":["{{apiVersion}}","api","Member","Enroll-Member-Bulk"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"3954f334-26f6-4b18-be46-47983667450f","name":"Batch accepted","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"RecordMode\": 1,\n \"RecordType\": \"N\",\n \"PayorID\": \"CLI01\",\n \"MemberID\": \"MEM00000001\",\n \"MappingID\": \"\",\n \"CardNumber\": \"9999000000000001\",\n \"CorporateEmail\": \"hr@example.com\",\n \"TpaMemberID\": \"\",\n \"CorporateID\": \"CORP01\",\n \"Nik\": \"0000000000000001\",\n \"Division\": \"\",\n \"BranchCode\": \"\",\n \"BankInfo\": \"\",\n \"Language\": \"id-id\",\n \"TypeOfWork\": 1,\n \"Race\": \"\",\n \"PolicyNumber\": \"POL0000000000001\",\n \"MaritalStatus\": \"S\",\n \"Relationship\": \"Principle\",\n \"MembersEffectiveDate\": \"2026-01-01\",\n \"MembersExpiryDate\": \"2026-12-31\",\n \"FaskesFKTP\": \"\",\n \"FaskesFKRTL\": \"\",\n \"ClassesBPJS\": \"\",\n \"NameOfFaskes\": \"\",\n \"RuleBPJSK\": \"\",\n \"MemberName\": \"John Doe\",\n \"Address1\": \"1 Sample Street\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"City\": \"Jakarta\",\n \"State\": \"DKI Jakarta\",\n \"PostCode\": \"10000\",\n \"TelephoneMobile\": \"+628000000001\",\n \"TelephoneRes\": \"\",\n \"TelephoneOffice\": \"\",\n \"NRIC\": \"\",\n \"PassportNo\": \"A0000001\",\n \"PassportCountry\": \"ID\",\n \"Email\": \"john.doe@example.com\",\n \"IdentificationCode\": \"\",\n \"DateOfBirth\": \"1990-01-01\",\n \"Sex\": \"M\",\n \"PlanID\": \"PLAN-001\",\n \"EmploymentStatus\": \"\",\n \"DateTerminated\": \"\",\n \"PreExisting\": \"\",\n \"BpjsID\": \"\",\n \"EndorsementDate\": \"\",\n \"Remarks\": \"\",\n \"MemberSince\": \"2026-01-01\",\n \"PolicyInForce\": \"1\",\n \"MemberSuspended\": \"0\",\n \"ActivationDate\": \"2026-01-01\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll-Member-Bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"data\": {\n \"processed\": 1,\n \"failed\": 0,\n \"rows\": [\n { \"memberId\": \"MEM00000001\", \"status\": \"OK\" }\n ]\n }\n}"},{"id":"a7ea864a-27d5-4ad6-9133-343d723fd7b4","name":"Empty array","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"RecordMode\": 1,\n \"RecordType\": \"N\",\n \"PayorID\": \"CLI01\",\n \"MemberID\": \"MEM00000001\",\n \"MappingID\": \"\",\n \"CardNumber\": \"9999000000000001\",\n \"CorporateEmail\": \"hr@example.com\",\n \"TpaMemberID\": \"\",\n \"CorporateID\": \"CORP01\",\n \"Nik\": \"0000000000000001\",\n \"Division\": \"\",\n \"BranchCode\": \"\",\n \"BankInfo\": \"\",\n \"Language\": \"id-id\",\n \"TypeOfWork\": 1,\n \"Race\": \"\",\n \"PolicyNumber\": \"POL0000000000001\",\n \"MaritalStatus\": \"S\",\n \"Relationship\": \"Principle\",\n \"MembersEffectiveDate\": \"2026-01-01\",\n \"MembersExpiryDate\": \"2026-12-31\",\n \"FaskesFKTP\": \"\",\n \"FaskesFKRTL\": \"\",\n \"ClassesBPJS\": \"\",\n \"NameOfFaskes\": \"\",\n \"RuleBPJSK\": \"\",\n \"MemberName\": \"John Doe\",\n \"Address1\": \"1 Sample Street\",\n \"Address2\": \"\",\n \"Address3\": \"\",\n \"Address4\": \"\",\n \"City\": \"Jakarta\",\n \"State\": \"DKI Jakarta\",\n \"PostCode\": \"10000\",\n \"TelephoneMobile\": \"+628000000001\",\n \"TelephoneRes\": \"\",\n \"TelephoneOffice\": \"\",\n \"NRIC\": \"\",\n \"PassportNo\": \"A0000001\",\n \"PassportCountry\": \"ID\",\n \"Email\": \"john.doe@example.com\",\n \"IdentificationCode\": \"\",\n \"DateOfBirth\": \"1990-01-01\",\n \"Sex\": \"M\",\n \"PlanID\": \"PLAN-001\",\n \"EmploymentStatus\": \"\",\n \"DateTerminated\": \"\",\n \"PreExisting\": \"\",\n \"BpjsID\": \"\",\n \"EndorsementDate\": \"\",\n \"Remarks\": \"\",\n \"MemberSince\": \"2026-01-01\",\n \"PolicyInForce\": \"1\",\n \"MemberSuspended\": \"0\",\n \"ActivationDate\": \"2026-01-01\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll-Member-Bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"errors\": {\n \"cardNumber\": [\n \"The cardNumber field is required.\"\n ]\n },\n \"traceId\": \"00-00000000000000000000000000000000-0000000000000000-00\"\n}"}],"_postman_id":"27b3515c-6c29-4b84-934c-670780e60af1"},{"name":"New Bulk Enrollment","id":"6a1d0ac5-888b-4611-b83c-5cab460452ad","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"RecordMode\": 1,\n \"MemberType\": \"Principle\",\n \"MemberID\": \"MEM00000001\",\n \"MappingID\": \"\",\n \"MemberName\": \"John Doe\",\n \"Nik\": \"0000000000000001\",\n \"DateOfBirth\": \"1990-01-01\",\n \"Sex\": \"M\",\n \"Relationship\": \"Principle\",\n \"MaritalStatus\": \"S\",\n \"TelephoneMobile\": \"+628000000001\",\n \"Email\": \"john.doe@example.com\",\n \"MemberAdress\": \"1 Sample Street, Jakarta\",\n \"NRIC\": \"\",\n \"BankInfo\": \"Sample Bank\",\n \"BankAccountHolder\": \"John Doe\",\n \"BankAccountNumber\": \"0000000001\",\n \"BpjsNumber\": \"\",\n \"Remarks\": \"\",\n \"MemberSince\": \"2026-01-01\",\n \"MembersEffectiveDate\": \"2026-01-01\",\n \"MembersExpiryDate\": \"2026-12-31\",\n \"UnsuspendDate\": \"\",\n \"ReinstateDate\": \"\",\n \"LapseDate\": \"\",\n \"SuspendDate\": \"\",\n \"DateTerminated\": \"\",\n \"PayorID\": \"CLI01\",\n \"IsVip\": 0,\n \"ProductCode\": \"PRD001\",\n \"PlanID\": \"PLAN-001\",\n \"PolicyNumber\": \"POL0000000000001\",\n \"Division\": \"\",\n \"DivisionName\": \"\",\n \"TelephoneOffice\": \"\",\n \"CardNumber\": \"9999000000000001\",\n \"CorporateEmail\": \"hr@example.com\",\n \"AdditionalData\": [],\n \"RecordType\": \"N\",\n \"CorporateID\": \"CORP01\",\n \"TypeOfWork\": 1,\n \"Address1\": \"1 Sample Street\",\n \"BranchCode\": \"\",\n \"TpaMemberID\": \"\",\n \"EmploymentStatus\": \"\",\n \"UpdatedBy\": \"\",\n \"CreatedBy\": \"integration@example.com\",\n \"Username\": \"integration@example.com\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/New-Enroll-Member-Bulk","description":"

Bulk enrol members using the product-based record.

POST {{base}}/api/Member/New-Enroll-Member-Bulk

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Success	`200 OK`

Description

Takes an array of enrolment records in the newer product-based format, 48 fields each. Compared with Enroll-Member-Bulk it adds ProductCode, splits bank details into BankAccountHolder and BankAccountNumber, carries a fuller set of lifecycle dates (UnsuspendDate, ReinstateDate, LapseDate, SuspendDate), supports AdditionalData for client-specific columns, and drops the BPJS Faskes fields.

Both bulk endpoints are live. Use whichever your integration was set up against.

Request body - array item

Required fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`RecordMode`	integer	Operation selector for the row.
`MemberType`	string	Member type.
`MemberID`	string	Your identifier for the member.
`MemberName`	string	Full name.
`Sex`	string	`M` / `F`.
`PayorID`	string	Payor identifier.
`ProductCode`	string	Product the member is enrolled onto.
`PolicyNumber`	string	Policy number.
`Username`	string	Who submitted the row.

Optional fields: MappingID, Nik, DateOfBirth, Relationship, MaritalStatus, TelephoneMobile, TelephoneOffice, Email, MemberAdress, NRIC, BankInfo, BankAccountHolder, BankAccountNumber, BpjsNumber, Remarks, MemberSince, MembersEffectiveDate, MembersExpiryDate, UnsuspendDate, ReinstateDate, LapseDate, SuspendDate, DateTerminated, IsVip, PlanID, Division, DivisionName, CardNumber, CorporateEmail, AdditionalData, RecordType, CorporateID, TypeOfWork, Address1, BranchCode, TpaMemberID, EmploymentStatus, UpdatedBy, CreatedBy.

AdditionalData is an array of client-specific membership attributes. MemberAdress is spelled with one d - that is the real field name.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Batch accepted. Per-row outcomes are in the response body.
`400`	The array was empty or a row failed validation.
`401`	Missing or expired token.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"f46241f1-1ecb-488c-9bdf-6eef5ca11d9d","id":"f46241f1-1ecb-488c-9bdf-6eef5ca11d9d","name":"Bulk Enrollment New Member","type":"folder"}},"urlObject":{"path":["{{apiVersion}}","api","Member","New-Enroll-Member-Bulk"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"ebdabf6d-c58c-474a-973d-c4ad78d16045","name":"Batch accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"RecordMode\": 1,\n \"MemberType\": \"Principle\",\n \"MemberID\": \"MEM00000001\",\n \"MappingID\": \"\",\n \"MemberName\": \"John Doe\",\n \"Nik\": \"0000000000000001\",\n \"DateOfBirth\": \"1990-01-01\",\n \"Sex\": \"M\",\n \"Relationship\": \"Principle\",\n \"MaritalStatus\": \"S\",\n \"TelephoneMobile\": \"+628000000001\",\n \"Email\": \"john.doe@example.com\",\n \"MemberAdress\": \"1 Sample Street, Jakarta\",\n \"NRIC\": \"\",\n \"BankInfo\": \"Sample Bank\",\n \"BankAccountHolder\": \"John Doe\",\n \"BankAccountNumber\": \"0000000001\",\n \"BpjsNumber\": \"\",\n \"Remarks\": \"\",\n \"MemberSince\": \"2026-01-01\",\n \"MembersEffectiveDate\": \"2026-01-01\",\n \"MembersExpiryDate\": \"2026-12-31\",\n \"UnsuspendDate\": \"\",\n \"ReinstateDate\": \"\",\n \"LapseDate\": \"\",\n \"SuspendDate\": \"\",\n \"DateTerminated\": \"\",\n \"PayorID\": \"CLI01\",\n \"IsVip\": 0,\n \"ProductCode\": \"PRD001\",\n \"PlanID\": \"PLAN-001\",\n \"PolicyNumber\": \"POL0000000000001\",\n \"Division\": \"\",\n \"DivisionName\": \"\",\n \"TelephoneOffice\": \"\",\n \"CardNumber\": \"9999000000000001\",\n \"CorporateEmail\": \"hr@example.com\",\n \"AdditionalData\": [],\n \"RecordType\": \"N\",\n \"CorporateID\": \"CORP01\",\n \"TypeOfWork\": 1,\n \"Address1\": \"1 Sample Street\",\n \"BranchCode\": \"\",\n \"TpaMemberID\": \"\",\n \"EmploymentStatus\": \"\",\n \"UpdatedBy\": \"\",\n \"CreatedBy\": \"integration@example.com\",\n \"Username\": \"integration@example.com\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/New-Enroll-Member-Bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"data\": {\n \"processed\": 1,\n \"failed\": 0,\n \"rows\": [\n { \"memberId\": \"MEM00000001\", \"status\": \"OK\" }\n ]\n }\n}"},{"id":"765d5bca-9ac0-464b-a2f4-e74d7a13e4ec","name":"Empty array","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"RecordMode\": 1,\n \"MemberType\": \"Principle\",\n \"MemberID\": \"MEM00000001\",\n \"MappingID\": \"\",\n \"MemberName\": \"John Doe\",\n \"Nik\": \"0000000000000001\",\n \"DateOfBirth\": \"1990-01-01\",\n \"Sex\": \"M\",\n \"Relationship\": \"Principle\",\n \"MaritalStatus\": \"S\",\n \"TelephoneMobile\": \"+628000000001\",\n \"Email\": \"john.doe@example.com\",\n \"MemberAdress\": \"1 Sample Street, Jakarta\",\n \"NRIC\": \"\",\n \"BankInfo\": \"Sample Bank\",\n \"BankAccountHolder\": \"John Doe\",\n \"BankAccountNumber\": \"0000000001\",\n \"BpjsNumber\": \"\",\n \"Remarks\": \"\",\n \"MemberSince\": \"2026-01-01\",\n \"MembersEffectiveDate\": \"2026-01-01\",\n \"MembersExpiryDate\": \"2026-12-31\",\n \"UnsuspendDate\": \"\",\n \"ReinstateDate\": \"\",\n \"LapseDate\": \"\",\n \"SuspendDate\": \"\",\n \"DateTerminated\": \"\",\n \"PayorID\": \"CLI01\",\n \"IsVip\": 0,\n \"ProductCode\": \"PRD001\",\n \"PlanID\": \"PLAN-001\",\n \"PolicyNumber\": \"POL0000000000001\",\n \"Division\": \"\",\n \"DivisionName\": \"\",\n \"TelephoneOffice\": \"\",\n \"CardNumber\": \"9999000000000001\",\n \"CorporateEmail\": \"hr@example.com\",\n \"AdditionalData\": [],\n \"RecordType\": \"N\",\n \"CorporateID\": \"CORP01\",\n \"TypeOfWork\": 1,\n \"Address1\": \"1 Sample Street\",\n \"BranchCode\": \"\",\n \"TpaMemberID\": \"\",\n \"EmploymentStatus\": \"\",\n \"UpdatedBy\": \"\",\n \"CreatedBy\": \"integration@example.com\",\n \"Username\": \"integration@example.com\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/New-Enroll-Member-Bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"errors\": {\n \"cardNumber\": [\n \"The cardNumber field is required.\"\n ]\n },\n \"traceId\": \"00-00000000000000000000000000000000-0000000000000000-00\"\n}"}],"_postman_id":"6a1d0ac5-888b-4611-b83c-5cab460452ad"}],"id":"f46241f1-1ecb-488c-9bdf-6eef5ca11d9d","description":"

Enrol many members in one call.

Two variants exist and both are live:

Enroll-Member-Bulk - the original NOVA-style flat record (55 fields), including BPJS fields such as FaskesFKTP, ClassesBPJS and RuleBPJSK.
New-Enroll-Member-Bulk - the newer product-based record (48 fields), with ProductCode, split bank account fields and a richer set of lifecycle dates.

Use the one your integration was set up against; they are not interchangeable.

Amend an existing member, or add a dependant to an existing principal.

PUT {{base}}/api/Member/Enroll-Member

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Success	`202 Accepted`

Description

Use this for two jobs:

Correct a member's details - date of birth, name, phone. Send the member without principal.
Add a dependant - send the dependant's details with member.principal set to the principal's member number and the relationship.

The body is identical in shape to Enrollment New Member. The difference is the HTTP method and that the member/policy must already exist - if it does not, the call is refused with MemberOrPolicyNotExist.

Request body

Same as POST /api/Member/Enroll: corporateCode, actionDescription, member, policy, all required. See that endpoint for the full field tables.

To enrol a dependant:

\"principal\": { \"memberNumber\": \"MEM00000001\", \"relationship\": \"Spouse\" }\n

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`202`	Change accepted and applied downstream.
`400`	No such member/policy, or a field failed validation.
`401`	Missing or expired token.

Response fields - `data[]`

Every enrolment endpoint returns the same array of member records. All are always present.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`memberNumber`	string	No	Your member identifier, as supplied.
`memberPrincipalNumber`	string	Yes	The principal's member number. `null` for a principal.
`name`	string	No	Member name.
`phoneNumber`	string	Yes	Mobile number.
`dateOfBirth`	string	No	`yyyy-MM-dd`.
`memberStatus`	string	No	e.g. `ACTIVE`, `SUSPEND`, `TERMINATE`.
`familyStatus`	string	No	e.g. `Principle`, `Spouse`, `Child`.
`policyNumber`	string	No	Policy the record belongs to.
`planCode`	string[]	No	Plan codes on the policy. Split from a semicolon-delimited downstream value, so an empty policy yields `[]`.

The array contains the member you acted on and any family members affected by the same change.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	ErrorCode	Message
400	`MemberAndPolicyExist`	Policy for this member already exist. To update the plan, please use PUT method instead.
400	`MemberOrPolicyNotExist`	Policy for this member not exist.
400	(RFC 7807)	A required field was missing or mistyped - see `errors`.
401	-	Missing or expired token. Empty body.

","urlObject":{"path":["{{apiVersion}}","api","Member","Enroll-Member"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"ce363aaf-5c22-4ba1-ad18-4f4f927f177f","name":"Dependant added","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Add spouse as dependant\",\n \"member\": {\n \"memberNumber\": \"MEM00000002\",\n \"name\": \"Jane Doe\",\n \"sex\": \"F\",\n \"maritalStatus\": \"M\",\n \"dateOfBirth\": \"1992-01-01\",\n \"planDescription\": \"Sample Inpatient Plan\",\n \"bankCode\": \"\",\n \"memberType\": \"\",\n \"phoneNumber\": \"+628000000002\",\n \"principal\": {\n \"memberNumber\": \"MEM00000001\",\n \"relationship\": \"Spouse\"\n }\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2026-01-01\",\n \"endDate\": \"2026-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-001\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll-Member"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"memberNumber\": \"MEM00000001\",\n \"memberPrincipalNumber\": null,\n \"name\": \"John Doe\",\n \"phoneNumber\": \"+628000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"memberStatus\": \"ACTIVE\",\n \"familyStatus\": \"Principle\",\n \"policyNumber\": \"POL0000000000001\",\n \"planCode\": [\n \"PLAN-001\"\n ]\n }\n ]\n}"},{"id":"1b468693-2e3b-44ad-8962-cc1b9ccc2a69","name":"No such member or policy","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Add spouse as dependant\",\n \"member\": {\n \"memberNumber\": \"MEM00000002\",\n \"name\": \"Jane Doe\",\n \"sex\": \"F\",\n \"maritalStatus\": \"M\",\n \"dateOfBirth\": \"1992-01-01\",\n \"planDescription\": \"Sample Inpatient Plan\",\n \"bankCode\": \"\",\n \"memberType\": \"\",\n \"phoneNumber\": \"+628000000002\",\n \"principal\": {\n \"memberNumber\": \"MEM00000001\",\n \"relationship\": \"Spouse\"\n }\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2026-01-01\",\n \"endDate\": \"2026-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-001\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll-Member"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"MemberOrPolicyNotExist\",\n \"Message\": \"Policy for this member not exist.\"\n }\n ]\n}"}],"_postman_id":"25116f00-4658-4924-b283-d0a7f8a95cb4"}],"id":"a989b735-bf22-4a0c-a75e-f0c49d6ad67a","description":"

Amend an existing member's details, or add a dependant to an existing principal.

Set member.principal to the principal's member number when enrolling a dependant. Returns 202.

Move a member onto a different plan.

PUT {{base}}/api/Member/Enroll-Change-Plan

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Success	`202 Accepted`

Description

Upgrade or downgrade the plans on an existing policy. member here is the slim form - member number and optionally the principal, nothing else. The new plans go in policy.plans.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Description
`corporateCode`	string	Yes	The corporate the member belongs to.
`actionDescription`	string	Yes	Free-text reason for the change.
`member`	object	Yes	`{ memberNumber, principal? }` - not the full member record.
`member.memberNumber`	string	Yes	Your identifier for the member.
`member.principal`	object	No	`{ memberNumber, relationship }` when acting on a dependant.
`policy`	object	Yes	`{ policyNumber, startDate, endDate, plans, remarks? }`.
`policy.plans`	array	No	The plans the member should now hold: `[{ planCode, isActive }]`.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`202`	Plan change accepted.
`400`	No such member/policy, or a field failed validation.
`401`	Missing or expired token.

Response fields - `data[]`

Every enrolment endpoint returns the same array of member records. All are always present.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`memberNumber`	string	No	Your member identifier, as supplied.
`memberPrincipalNumber`	string	Yes	The principal's member number. `null` for a principal.
`name`	string	No	Member name.
`phoneNumber`	string	Yes	Mobile number.
`dateOfBirth`	string	No	`yyyy-MM-dd`.
`memberStatus`	string	No	e.g. `ACTIVE`, `SUSPEND`, `TERMINATE`.
`familyStatus`	string	No	e.g. `Principle`, `Spouse`, `Child`.
`policyNumber`	string	No	Policy the record belongs to.
`planCode`	string[]	No	Plan codes on the policy. Split from a semicolon-delimited downstream value, so an empty policy yields `[]`.

The array contains the member you acted on and any family members affected by the same change.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	ErrorCode	Message
400	`MemberAndPolicyExist`	Policy for this member already exist. To update the plan, please use PUT method instead.
400	`MemberOrPolicyNotExist`	Policy for this member not exist.
400	(RFC 7807)	A required field was missing or mistyped - see `errors`.
401	-	Missing or expired token. Empty body.

","urlObject":{"path":["{{apiVersion}}","api","Member","Enroll-Change-Plan"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"704b5e28-10e6-4caf-aec4-48b2ff2448dd","name":"Plan changed","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"PUT","header":[{"key":"accept","value":"text/plain"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Upgrade to PLAN-002\",\n \"member\": {\n \"memberNumber\": \"MEM00000001\",\n \"principal\": null\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2026-01-01\",\n \"endDate\": \"2026-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-002\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll-Change-Plan"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"memberNumber\": \"MEM00000001\",\n \"memberPrincipalNumber\": null,\n \"name\": \"John Doe\",\n \"phoneNumber\": \"+628000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"memberStatus\": \"ACTIVE\",\n \"familyStatus\": \"Principle\",\n \"policyNumber\": \"POL0000000000001\",\n \"planCode\": [\n \"PLAN-001\"\n ]\n }\n ]\n}"},{"id":"cd87eeed-6af1-4e50-8e6c-6845bca70fa8","name":"No such member or policy","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"PUT","header":[{"key":"accept","value":"text/plain"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Upgrade to PLAN-002\",\n \"member\": {\n \"memberNumber\": \"MEM00000001\",\n \"principal\": null\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2026-01-01\",\n \"endDate\": \"2026-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-002\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll-Change-Plan"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"MemberOrPolicyNotExist\",\n \"Message\": \"Policy for this member not exist.\"\n }\n ]\n}"}],"_postman_id":"3d826280-a77a-4b30-a88b-e9e6de2c79c2"}],"id":"b9224712-607b-4990-be8a-8ba07d228218","description":"

Move a member onto a different plan. Returns 202.

Takes only the member number and the policy's plan list - not the full member record.

Change the effective dates of a member's current policy.

PUT {{base}}/api/Member/Enroll-Update-Effective

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Success	`202 Accepted`

Description

Amends the existing policy period - use it to correct a start or end date that was entered wrongly. To extend a policy into a new term, use Renewal instead.

Takes the slim member form: member number and optionally the principal.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Format	Req.	Description
`corporateCode`	string	-	Yes	The corporate the member belongs to.
`actionDescription`	string	-	Yes	Free-text reason for the change.
`member.memberNumber`	string	-	Yes	Your identifier for the member.
`member.principal`	object	-	No	`{ memberNumber, relationship }` for a dependant.
`policy.policyNumber`	string	-	Yes	Policy to amend.
`policy.startDate`	string	`yyyy-MM-dd`	Yes	Corrected start date.
`policy.endDate`	string	`yyyy-MM-dd`	Yes	Corrected end date.
`policy.plans`	array	-	No	`[{ planCode, isActive }]`.
`policy.remarks`	string	-	No	Free-text remarks.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`202`	Dates accepted.
`400`	No such member/policy, or a field failed validation.
`401`	Missing or expired token.

Response fields - `data[]`

Every enrolment endpoint returns the same array of member records. All are always present.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`memberNumber`	string	No	Your member identifier, as supplied.
`memberPrincipalNumber`	string	Yes	The principal's member number. `null` for a principal.
`name`	string	No	Member name.
`phoneNumber`	string	Yes	Mobile number.
`dateOfBirth`	string	No	`yyyy-MM-dd`.
`memberStatus`	string	No	e.g. `ACTIVE`, `SUSPEND`, `TERMINATE`.
`familyStatus`	string	No	e.g. `Principle`, `Spouse`, `Child`.
`policyNumber`	string	No	Policy the record belongs to.
`planCode`	string[]	No	Plan codes on the policy. Split from a semicolon-delimited downstream value, so an empty policy yields `[]`.

The array contains the member you acted on and any family members affected by the same change.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	ErrorCode	Message
400	`MemberAndPolicyExist`	Policy for this member already exist. To update the plan, please use PUT method instead.
400	`MemberOrPolicyNotExist`	Policy for this member not exist.
400	(RFC 7807)	A required field was missing or mistyped - see `errors`.
401	-	Missing or expired token. Empty body.

","urlObject":{"path":["{{apiVersion}}","api","Member","Enroll-Update-Effective"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"36104afb-ac9e-4459-89d8-17402f1c79d0","name":"Dates updated","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"PUT","header":[{"key":"accept","value":"text/plain"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Correct policy start date\",\n \"member\": {\n \"memberNumber\": \"MEM00000001\",\n \"principal\": null\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2026-02-01\",\n \"endDate\": \"2026-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-001\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll-Update-Effective"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"memberNumber\": \"MEM00000001\",\n \"memberPrincipalNumber\": null,\n \"name\": \"John Doe\",\n \"phoneNumber\": \"+628000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"memberStatus\": \"ACTIVE\",\n \"familyStatus\": \"Principle\",\n \"policyNumber\": \"POL0000000000001\",\n \"planCode\": [\n \"PLAN-001\"\n ]\n }\n ]\n}"},{"id":"1101c78c-d308-4f98-9ebe-7f20a374daa6","name":"No such member or policy","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"PUT","header":[{"key":"accept","value":"text/plain"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Correct policy start date\",\n \"member\": {\n \"memberNumber\": \"MEM00000001\",\n \"principal\": null\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2026-02-01\",\n \"endDate\": \"2026-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-001\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll-Update-Effective"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"MemberOrPolicyNotExist\",\n \"Message\": \"Policy for this member not exist.\"\n }\n ]\n}"}],"_postman_id":"e198757f-8916-4388-93d5-906737839324"},{"name":"Renewal","id":"c657c5dc-79fd-4655-942e-d4ab1fb4d952","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"accept","value":"text/plain"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Annual renewal 2027\",\n \"member\": {\n \"memberNumber\": \"MEM00000001\",\n \"principal\": null\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2027-01-01\",\n \"endDate\": \"2027-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-001\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/Enroll-Renewal","description":"

Renew a member's policy into a new term.

PUT {{base}}/api/Member/Enroll-Renewal

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Success	`202 Accepted`

Description

Extends cover into a further period. Send the new term in policy.startDate and policy.endDate. To correct the dates of the current term rather than renew, use Update-Effective.

Body shape is identical to Update-Effective.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Format	Req.	Description
`corporateCode`	string	-	Yes	The corporate the member belongs to.
`actionDescription`	string	-	Yes	Free-text reason, e.g. `Annual renewal 2026`.
`member.memberNumber`	string	-	Yes	Your identifier for the member.
`member.principal`	object	-	No	`{ memberNumber, relationship }` for a dependant.
`policy.policyNumber`	string	-	Yes	Policy being renewed.
`policy.startDate`	string	`yyyy-MM-dd`	Yes	New term start.
`policy.endDate`	string	`yyyy-MM-dd`	Yes	New term end.
`policy.plans`	array	-	No	Plans for the new term.
`policy.remarks`	string	-	No	Free-text remarks.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`202`	Renewal accepted.
`400`	No such member/policy, or a field failed validation.
`401`	Missing or expired token.

Response fields - `data[]`

Every enrolment endpoint returns the same array of member records. All are always present.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`memberNumber`	string	No	Your member identifier, as supplied.
`memberPrincipalNumber`	string	Yes	The principal's member number. `null` for a principal.
`name`	string	No	Member name.
`phoneNumber`	string	Yes	Mobile number.
`dateOfBirth`	string	No	`yyyy-MM-dd`.
`memberStatus`	string	No	e.g. `ACTIVE`, `SUSPEND`, `TERMINATE`.
`familyStatus`	string	No	e.g. `Principle`, `Spouse`, `Child`.
`policyNumber`	string	No	Policy the record belongs to.
`planCode`	string[]	No	Plan codes on the policy. Split from a semicolon-delimited downstream value, so an empty policy yields `[]`.

The array contains the member you acted on and any family members affected by the same change.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	ErrorCode	Message
400	`MemberAndPolicyExist`	Policy for this member already exist. To update the plan, please use PUT method instead.
400	`MemberOrPolicyNotExist`	Policy for this member not exist.
400	(RFC 7807)	A required field was missing or mistyped - see `errors`.
401	-	Missing or expired token. Empty body.

","urlObject":{"path":["{{apiVersion}}","api","Member","Enroll-Renewal"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"431a31b8-1035-4789-b4eb-a976d3e96a88","name":"Policy renewed","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"PUT","header":[{"key":"accept","value":"text/plain"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Annual renewal 2027\",\n \"member\": {\n \"memberNumber\": \"MEM00000001\",\n \"principal\": null\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2027-01-01\",\n \"endDate\": \"2027-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-001\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll-Renewal"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"memberNumber\": \"MEM00000001\",\n \"memberPrincipalNumber\": null,\n \"name\": \"John Doe\",\n \"phoneNumber\": \"+628000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"memberStatus\": \"ACTIVE\",\n \"familyStatus\": \"Principle\",\n \"policyNumber\": \"POL0000000000001\",\n \"planCode\": [\n \"PLAN-001\"\n ]\n }\n ]\n}"},{"id":"cd57b143-5033-44bc-8ef0-be7e0e6cd239","name":"No such member or policy","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"PUT","header":[{"key":"accept","value":"text/plain"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Annual renewal 2027\",\n \"member\": {\n \"memberNumber\": \"MEM00000001\",\n \"principal\": null\n },\n \"policy\": {\n \"policyNumber\": \"POL0000000000001\",\n \"startDate\": \"2027-01-01\",\n \"endDate\": \"2027-12-31\",\n \"plans\": [\n { \"planCode\": \"PLAN-001\", \"isActive\": true }\n ],\n \"remarks\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Enroll-Renewal"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"MemberOrPolicyNotExist\",\n \"Message\": \"Policy for this member not exist.\"\n }\n ]\n}"}],"_postman_id":"c657c5dc-79fd-4655-942e-d4ab1fb4d952"}],"id":"df1f9e49-b6fc-49a2-9f1b-e346814e8369","description":"

Change a policy's effective dates, or renew it for a further term. Both return 202.

Update-Effective amends the current policy period. Renewal extends it into a new one.

Terminate a member's policy.

POST {{base}}/api/Member/Terminate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Success	`202 Accepted`

Description

Ends cover. Reverse it with ReActivate, which re-enrols the member - not with Reinstate, which only lifts a suspension.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Description
`memberNumber`	string	Yes	Your identifier for the member.
`policyNumber`	string	Yes	Policy to terminate.
`corporateCode`	string	Yes	The corporate the member belongs to.
`actionDescription`	string	Yes	Free-text reason for the termination.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`202`	Termination accepted. Returned records show `memberStatus: \"TERMINATE\"`.
`400`	No such member/policy, or a field failed validation.
`401`	Missing or expired token.

Response fields - `data[]`

Every enrolment endpoint returns the same array of member records. All are always present.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`memberNumber`	string	No	Your member identifier, as supplied.
`memberPrincipalNumber`	string	Yes	The principal's member number. `null` for a principal.
`name`	string	No	Member name.
`phoneNumber`	string	Yes	Mobile number.
`dateOfBirth`	string	No	`yyyy-MM-dd`.
`memberStatus`	string	No	e.g. `ACTIVE`, `SUSPEND`, `TERMINATE`.
`familyStatus`	string	No	e.g. `Principle`, `Spouse`, `Child`.
`policyNumber`	string	No	Policy the record belongs to.
`planCode`	string[]	No	Plan codes on the policy. Split from a semicolon-delimited downstream value, so an empty policy yields `[]`.

The array contains the member you acted on and any family members affected by the same change.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	ErrorCode	Message
400	`MemberAndPolicyExist`	Policy for this member already exist. To update the plan, please use PUT method instead.
400	`MemberOrPolicyNotExist`	Policy for this member not exist.
400	(RFC 7807)	A required field was missing or mistyped - see `errors`.
401	-	Missing or expired token. Empty body.

","urlObject":{"path":["{{apiVersion}}","api","Member","Terminate"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"dc851794-7a24-4dc0-980e-ebe242b5e9cc","name":"Terminated","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"memberNumber\": \"MEM00000001\",\n \"policyNumber\": \"POL0000000000001\",\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Employment ended\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Terminate"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"memberNumber\": \"MEM00000001\",\n \"memberPrincipalNumber\": null,\n \"name\": \"John Doe\",\n \"phoneNumber\": \"+628000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"memberStatus\": \"TERMINATE\",\n \"familyStatus\": \"Principle\",\n \"policyNumber\": \"POL0000000000001\",\n \"planCode\": [\n \"PLAN-001\"\n ]\n }\n ]\n}"},{"id":"3c5f65b6-bc9b-42f6-bc65-13df44ae7e73","name":"No such member or policy","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"memberNumber\": \"MEM00000001\",\n \"policyNumber\": \"POL0000000000001\",\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Employment ended\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Terminate"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"MemberOrPolicyNotExist\",\n \"Message\": \"Policy for this member not exist.\"\n }\n ]\n}"}],"_postman_id":"0725789d-4453-4bd0-9aa7-64730def45b2"},{"name":"Suspend","id":"37089096-93e8-4590-9ce0-9db9d3fb6f4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"memberNumber\": \"MEM00000001\",\n \"policyNumber\": \"POL0000000000001\",\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Premium unpaid - suspend pending payment\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/Suspend","description":"

Suspend a member's policy.

POST {{base}}/api/Member/Suspend

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Success	`202 Accepted`

Description

Takes cover out of force temporarily - claims are refused while suspended. Reverse it with Reinstate, not ReActivate.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Description
`memberNumber`	string	Yes	Your identifier for the member.
`policyNumber`	string	Yes	Policy to suspend.
`corporateCode`	string	Yes	The corporate the member belongs to.
`actionDescription`	string	Yes	Free-text reason for the suspension.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`202`	Suspension accepted. Returned records show `memberStatus: \"SUSPEND\"`.
`400`	No such member/policy, or a field failed validation.
`401`	Missing or expired token.

Response fields - `data[]`

Every enrolment endpoint returns the same array of member records. All are always present.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`memberNumber`	string	No	Your member identifier, as supplied.
`memberPrincipalNumber`	string	Yes	The principal's member number. `null` for a principal.
`name`	string	No	Member name.
`phoneNumber`	string	Yes	Mobile number.
`dateOfBirth`	string	No	`yyyy-MM-dd`.
`memberStatus`	string	No	e.g. `ACTIVE`, `SUSPEND`, `TERMINATE`.
`familyStatus`	string	No	e.g. `Principle`, `Spouse`, `Child`.
`policyNumber`	string	No	Policy the record belongs to.
`planCode`	string[]	No	Plan codes on the policy. Split from a semicolon-delimited downstream value, so an empty policy yields `[]`.

The array contains the member you acted on and any family members affected by the same change.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	ErrorCode	Message
400	`MemberAndPolicyExist`	Policy for this member already exist. To update the plan, please use PUT method instead.
400	`MemberOrPolicyNotExist`	Policy for this member not exist.
400	(RFC 7807)	A required field was missing or mistyped - see `errors`.
401	-	Missing or expired token. Empty body.

","urlObject":{"path":["{{apiVersion}}","api","Member","Suspend"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"5fb3e4bd-a4d2-402b-a4fb-71fa5fea67bc","name":"Suspended","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"memberNumber\": \"MEM00000001\",\n \"policyNumber\": \"POL0000000000001\",\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Premium unpaid - suspend pending payment\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Suspend"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"memberNumber\": \"MEM00000001\",\n \"memberPrincipalNumber\": null,\n \"name\": \"John Doe\",\n \"phoneNumber\": \"+628000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"memberStatus\": \"SUSPEND\",\n \"familyStatus\": \"Principle\",\n \"policyNumber\": \"POL0000000000001\",\n \"planCode\": [\n \"PLAN-001\"\n ]\n }\n ]\n}"},{"id":"7824e4fc-08d3-4292-9067-3a24b509d26b","name":"No such member or policy","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"body":{"mode":"raw","raw":"{\n \"memberNumber\": \"MEM00000001\",\n \"policyNumber\": \"POL0000000000001\",\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Premium unpaid - suspend pending payment\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Suspend"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"MemberOrPolicyNotExist\",\n \"Message\": \"Policy for this member not exist.\"\n }\n ]\n}"}],"_postman_id":"37089096-93e8-4590-9ce0-9db9d3fb6f4b"},{"name":"Reinstate","id":"203039e1-3ade-4ea2-b600-bfe738daeb40","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"memberNumber\": \"MEM00000001\",\n \"policyNumber\": \"POL0000000000001\",\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Premium received - lift suspension\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/Reinstate","description":"

Reverse a suspension and put the policy back in force.

POST {{base}}/api/Member/Reinstate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Success	`202 Accepted`

Description

The counterpart to Suspend. For a terminated member use ReActivate instead - the two are not interchangeable.

Reinstating a member who is not suspended is a no-op, not an error: the call returns 200 and changes nothing. Safe to retry.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Description
`memberNumber`	string	Yes	Your identifier for the member.
`policyNumber`	string	Yes	Policy to reinstate.
`corporateCode`	string	Yes	The corporate the member belongs to.
`actionDescription`	string	Yes	Free-text reason for the reinstatement.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`202`	Reinstatement accepted.
`200`	Member was not suspended - request ignored.
`400`	No such member/policy, or a field failed validation.
`401`	Missing or expired token.

Response fields - `data[]`

Every enrolment endpoint returns the same array of member records. All are always present.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`memberNumber`	string	No	Your member identifier, as supplied.
`memberPrincipalNumber`	string	Yes	The principal's member number. `null` for a principal.
`name`	string	No	Member name.
`phoneNumber`	string	Yes	Mobile number.
`dateOfBirth`	string	No	`yyyy-MM-dd`.
`memberStatus`	string	No	e.g. `ACTIVE`, `SUSPEND`, `TERMINATE`.
`familyStatus`	string	No	e.g. `Principle`, `Spouse`, `Child`.
`policyNumber`	string	No	Policy the record belongs to.
`planCode`	string[]	No	Plan codes on the policy. Split from a semicolon-delimited downstream value, so an empty policy yields `[]`.

The array contains the member you acted on and any family members affected by the same change.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	ErrorCode	Message
400	`MemberAndPolicyExist`	Policy for this member already exist. To update the plan, please use PUT method instead.
400	`MemberOrPolicyNotExist`	Policy for this member not exist.
400	(RFC 7807)	A required field was missing or mistyped - see `errors`.
401	-	Missing or expired token. Empty body.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"2f2a70fe-2034-4b14-a9ca-5edcbf92dd21","id":"2f2a70fe-2034-4b14-a9ca-5edcbf92dd21","name":"Deactivate Member","type":"folder"}},"urlObject":{"path":["{{apiVersion}}","api","Member","Reinstate"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"0bbf52c8-7a7f-45dd-874b-cac20309a3ed","name":"Reinstated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"memberNumber\": \"MEM00000001\",\n \"policyNumber\": \"POL0000000000001\",\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Premium received - lift suspension\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Reinstate"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"memberNumber\": \"MEM00000001\",\n \"memberPrincipalNumber\": null,\n \"name\": \"John Doe\",\n \"phoneNumber\": \"+628000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"memberStatus\": \"ACTIVE\",\n \"familyStatus\": \"Principle\",\n \"policyNumber\": \"POL0000000000001\",\n \"planCode\": [\n \"PLAN-001\"\n ]\n }\n ]\n}"},{"id":"bc9bf8db-d359-42a0-a7c7-9a4759af658d","name":"Not suspended - request ignored","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"memberNumber\": \"MEM00000001\",\n \"policyNumber\": \"POL0000000000001\",\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Premium received - lift suspension\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Reinstate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"memberNumber\": \"MEM00000001\",\n \"memberPrincipalNumber\": null,\n \"name\": \"John Doe\",\n \"phoneNumber\": \"+628000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"memberStatus\": \"ACTIVE\",\n \"familyStatus\": \"Principle\",\n \"policyNumber\": \"POL0000000000001\",\n \"planCode\": [\n \"PLAN-001\"\n ]\n }\n ]\n}"},{"id":"4d72d13d-84cb-42bd-8b2e-8f0e7b67e347","name":"No such member or policy","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"memberNumber\": \"MEM00000001\",\n \"policyNumber\": \"POL0000000000001\",\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Premium received - lift suspension\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/Reinstate"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"MemberOrPolicyNotExist\",\n \"Message\": \"Policy for this member not exist.\"\n }\n ]\n}"}],"_postman_id":"203039e1-3ade-4ea2-b600-bfe738daeb40"}],"id":"2f2a70fe-2034-4b14-a9ca-5edcbf92dd21","description":"

Take a member's policy out of force.

Suspend is reversible with Reinstate. Terminate is reversed with ReActivate, which re-enrols the member. Both return 202.

Re-enrol a terminated member.

POST {{base}}/api/Member/ReActivate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Success	`200 OK`

Description

Brings a terminated member back into force. Note this returns 200, unlike the other lifecycle actions which return 202.

For a suspended member use Reinstate instead.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Description
`memberNumber`	string	Yes	Your identifier for the member.
`policyNumber`	string	Yes	Policy to re-activate.
`corporateCode`	string	Yes	The corporate the member belongs to.
`actionDescription`	string	Yes	Free-text reason for the re-activation.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Re-enrolment accepted.
`400`	No such member/policy, or a field failed validation.
`401`	Missing or expired token.

Response fields - `data[]`

Every enrolment endpoint returns the same array of member records. All are always present.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`memberNumber`	string	No	Your member identifier, as supplied.
`memberPrincipalNumber`	string	Yes	The principal's member number. `null` for a principal.
`name`	string	No	Member name.
`phoneNumber`	string	Yes	Mobile number.
`dateOfBirth`	string	No	`yyyy-MM-dd`.
`memberStatus`	string	No	e.g. `ACTIVE`, `SUSPEND`, `TERMINATE`.
`familyStatus`	string	No	e.g. `Principle`, `Spouse`, `Child`.
`policyNumber`	string	No	Policy the record belongs to.
`planCode`	string[]	No	Plan codes on the policy. Split from a semicolon-delimited downstream value, so an empty policy yields `[]`.

The array contains the member you acted on and any family members affected by the same change.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	ErrorCode	Message
400	`MemberAndPolicyExist`	Policy for this member already exist. To update the plan, please use PUT method instead.
400	`MemberOrPolicyNotExist`	Policy for this member not exist.
400	(RFC 7807)	A required field was missing or mistyped - see `errors`.
401	-	Missing or expired token. Empty body.

","urlObject":{"path":["{{apiVersion}}","api","Member","ReActivate"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"52f20dd5-aa6b-4ee2-bf3f-58a789761343","name":"Re-enrolled","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"memberNumber\": \"MEM00000001\",\n \"policyNumber\": \"POL0000000000001\",\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Rehired - re-enrol member\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/ReActivate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"memberNumber\": \"MEM00000001\",\n \"memberPrincipalNumber\": null,\n \"name\": \"John Doe\",\n \"phoneNumber\": \"+628000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"memberStatus\": \"ACTIVE\",\n \"familyStatus\": \"Principle\",\n \"policyNumber\": \"POL0000000000001\",\n \"planCode\": [\n \"PLAN-001\"\n ]\n }\n ]\n}"},{"id":"6f2b9885-4750-4afd-a110-bdab9c6c9cd5","name":"No such member or policy","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"},{"key":"Authorization","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"memberNumber\": \"MEM00000001\",\n \"policyNumber\": \"POL0000000000001\",\n \"corporateCode\": \"CORP01\",\n \"actionDescription\": \"Rehired - re-enrol member\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/ReActivate"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"MemberOrPolicyNotExist\",\n \"Message\": \"Policy for this member not exist.\"\n }\n ]\n}"}],"_postman_id":"1b73975e-7971-4bb7-bd28-5c76f73e7e2e"}],"id":"6517676a-a5c8-4d96-8250-5e148a1133b2","description":"

Re-enrol a terminated member. Returns 200.

For a suspended member use Reinstate instead - ReActivate will not do what you want.

Create and maintain members and their policies.

All enrolment endpoints return the {\"data\": [...]} envelope with an array of member records, and use 201 for creation or 202 for an applied change - not 200.

Sequence: create the principal with Enrollment New Member, then add dependants or amend details with Update Member Data. Plan, date and lifecycle changes each have their own endpoint.

\n","_postman_id":"2d2b97ff-a068-48e0-bea4-09466fee41be","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"523f522d-2941-42db-a086-102b1051e12d","id":"523f522d-2941-42db-a086-102b1051e12d","name":"V1 & V2","type":"folder"}}},{"name":"Claim","item":[{"name":"List Claim per Member","id":"ea7bb798-a56e-42d1-bbb9-17794a57f929","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"email\": \"\",\n \"page\": { \"page\": 1, \"pageSize\": 10, \"query\": \"\" }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/GetListClaim","description":"

List a member's guarantee letters and claims.

POST {{base}}/api/Member/GetListClaim

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Envelope	Family C - no envelope; paging and `listGL` at the root

Description

Returns every claim raised for a member's card, newest first, as a paged list. Use Detail Claim for the full record of any one of them.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Default	Description
`cardNumber`	string	Yes	-	Member's card number.
`email`	string	No	-	Caller's email, recorded downstream.
`page`	object	No	-	Paging.
`page.page`	integer	No	`1`	Page number.
`page.pageSize`	integer	No	`10`	Page size.
`page.query`	string	No	`null`	Free-text search.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	The page of claims. Empty `listGL` when the member has none.
`400`	`cardNumber` missing - RFC 7807 with `traceId`.
`401`	Missing or expired token.

Response fields

Paging sits at the root, not inside a wrapper.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`page`	integer	No	Current page.
`pageSize`	integer	No	Page size.
`totalItems`	integer	No	Total claims for this card.
`totalPages`	integer	No	Total pages.
`listGL`	array	No	The claims. Empty array when none.

listGL[] - claimNumber, glNumber, cardNumber, memberName, providerName, planDetailName, planDetailCode, diagnosis1 and related fields. claimStatus is a numeric status code here, not a label - see Detail Claim for both the code and its display name.

\n","urlObject":{"path":["{{apiVersion}}","api","Member","GetListClaim"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"191270bf-cd18-449f-81fa-eedfb7feea9a","name":"Page of claims","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"email\": \"\",\n \"page\": { \"page\": 1, \"pageSize\": 10, \"query\": \"\" }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/GetListClaim"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"page\": 1,\n \"pageSize\": 10,\n \"totalItems\": 1,\n \"totalPages\": 1,\n \"listGL\": [\n {\n \"claimNumber\": \"CL2601010000001H\",\n \"claimStatus\": 304,\n \"cardNumber\": \"9999000000000001\",\n \"glNumber\": \"GL00000001\",\n \"memberName\": \"John Doe\",\n \"providerName\": \"Sample Clinic\",\n \"planDetailName\": null,\n \"planDetailCode\": null,\n \"diagnosis1\": \"Sample diagnosis\"\n }\n ]\n}"},{"id":"2e244456-9e3c-445b-ba8a-41d9b6389e81","name":"No claims","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"email\": \"\",\n \"page\": { \"page\": 1, \"pageSize\": 10, \"query\": \"\" }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/GetListClaim"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"page\": 1,\n \"pageSize\": 10,\n \"totalItems\": 0,\n \"totalPages\": 0,\n \"listGL\": []\n}"},{"id":"501fd340-b356-4499-bd01-a15e45097a46","name":"cardNumber missing","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"email\": \"\",\n \"page\": { \"page\": 1, \"pageSize\": 10, \"query\": \"\" }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/GetListClaim"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"errors\": {\n \"cardNumber\": [\n \"The cardNumber field is required.\"\n ]\n },\n \"traceId\": \"00-00000000000000000000000000000000-0000000000000000-00\"\n}"}],"_postman_id":"ea7bb798-a56e-42d1-bbb9-17794a57f929"},{"name":"Detail Claim","id":"2933369e-be7d-4824-b348-ef2b2d6195c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"claimNumber\": \"CL2601010000001H\",\n \"email\": \"\",\n \"clientCode\": \"CLI01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/GetDataClaim","description":"

Read one claim in full, including its status history.

POST {{base}}/api/Member/GetDataClaim

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Envelope	Family C - no envelope; root key `claims`

Description

The full record for a single claim. Identify the claim by both card number and claim number.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Description
`cardNumber`	string	Yes	Member's card number.
`claimNumber`	string	Yes	The claim to read.
`email`	string	No	Caller's email, recorded downstream.
`clientCode`	string	No	Client code, where the downstream requires it.

Both cardNumber and claimNumber are checked in the handler - omitting either returns 400.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	The claim, under `claims`.
`400`	`cardNumber` or `claimNumber` missing.
`500`	Downstream failure - `{\"Status\":500,\"Errors\":[{\"ErrorCode\":\"InternalServerError\",\"Message\":\"Internal server error. Please contact the client support.\"}]}`.
`401`	Missing or expired token.

Response fields - `claims`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`claimNumber`	string	Yes	The claim number.
`claimType`	string	Yes	e.g. `CASHLESS`.
`benefitType`	object	Yes	`{ type, display }` - e.g. `INPATIENT`.
`claimStatusCode`	integer	Yes	Numeric status.
`claimStatus`	string	Yes	Status label, e.g. `Admission Review`.
`lastStatusDate`	string(date-time)	Yes	When the status last changed.
`createdDate`, `updatedDate`	string(date-time)	Yes	Audit timestamps.

Both the numeric claimStatusCode and the human-readable claimStatus are returned - match on the code, display the label.

A 500 here is frequently a downstream NOVA problem rather than a bad request. Retry once before escalating, and quote the claim number.

\n","urlObject":{"path":["{{apiVersion}}","api","Member","GetDataClaim"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"cbb95246-a9d4-426d-842a-caac47a1a997","name":"Claim detail","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"claimNumber\": \"CL2601010000001H\",\n \"email\": \"\",\n \"clientCode\": \"CLI01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/GetDataClaim"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"claims\": {\n \"claimNumber\": \"CL2601010000001H\",\n \"createdDate\": \"2026-01-01T12:02:53.776192\",\n \"updatedDate\": \"2026-01-01T12:04:11.551473\",\n \"claimType\": \"CASHLESS\",\n \"benefitType\": {\n \"type\": \"INPATIENT\",\n \"display\": \"INPATIENT\"\n },\n \"claimStatusCode\": 4,\n \"claimStatus\": \"Admission Review\",\n \"lastStatusDate\": \"2026-01-01T12:04:11.551473\"\n }\n}"},{"id":"8d72dd16-c496-47df-8e64-d119743dcf58","name":"Downstream failure","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"claimNumber\": \"CL2601010000001H\",\n \"email\": \"\",\n \"clientCode\": \"CLI01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/GetDataClaim"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 500,\n \"Errors\": [\n {\n \"ErrorCode\": \"InternalServerError\",\n \"Message\": \"Internal server error. Please contact the client support.\"\n }\n ]\n}"}],"_postman_id":"2933369e-be7d-4824-b348-ef2b2d6195c7"},{"name":"Submit Reimbursement Claim","id":"95a8890d-3a67-464a-b5fd-068ae8b85dbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"benefitType\": \"INPATIENT\",\n \"dateOfAdmission\": \"2026-01-01T00:00:00Z\",\n \"dateOfDischarge\": \"2026-01-03T00:00:00Z\",\n \"receiptDate\": \"2026-01-03T00:00:00Z\",\n \"receiptAmount\": {\n \"currencyCode\": \"IDR\",\n \"amount\": 2500000\n },\n \"provider\": {\n \"name\": \"Sample Clinic\",\n \"address\": \"1 Sample Street, Jakarta\",\n \"coordinates\": \"-6.200000,106.800000\"\n },\n \"doctors\": \"Dr. Sample\",\n \"diagnoses\": \"Sample diagnosis\",\n \"remarks\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Claims/SubmitClaim","description":"

Submit a reimbursement claim with receipt details.

POST {{base}}/api/Claims/SubmitClaim

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Envelope	Family B - `{\"isSuccess\", \"data\"}`

Description

Raises a reimbursement claim for treatment the member has already paid for. Upload the supporting documents afterwards with Upload Docs, using the claim number this call returns.

For cashless claims use SubmitClaimCashless instead.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Format	Req.	Description
`cardNumber`	string	-	Yes	Member's card number.
`benefitType`	string	-	Yes	e.g. `INPATIENT`, `OUTPATIENT`.
`dateOfAdmission`	string	date-time	Yes	Admission date.
`dateOfDischarge`	string	date-time	Yes	Discharge date.
`receiptDate`	string	date-time	Yes	Date on the receipt.
`receiptAmount`	object	-	Yes	`{ currencyCode, amount }`.
`receiptAmount.currencyCode`	string	-	Yes	e.g. `IDR`.
`receiptAmount.amount`	number	decimal	Yes	Receipt total.
`provider`	object	-	Yes	`{ name, address, coordinates }`.
`doctors`	string	-	Yes	Treating doctor(s).
`diagnoses`	string	-	Yes	Diagnosis text.
`remarks`	string	-	Yes	Free-text remarks.

Dates on this endpoint are full ISO-8601 datetimes (2026-01-01T00:00:00Z), not yyyy-MM-dd.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Submitted. Check `isSuccess`.
`400`	Validation failure - also carries `{\"isSuccess\": false, …}`.
`401`	Missing or expired token.

Response fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`isSuccess`	boolean	No	Whether the claim was accepted.
`data`	object	Yes	The created claim, including its claim number - keep it for Upload Docs.

","urlObject":{"path":["{{apiVersion}}","api","Claims","SubmitClaim"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"a5af2cea-52bc-40ea-8174-2149582e0335","name":"Claim submitted","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"benefitType\": \"INPATIENT\",\n \"dateOfAdmission\": \"2026-01-01T00:00:00Z\",\n \"dateOfDischarge\": \"2026-01-03T00:00:00Z\",\n \"receiptDate\": \"2026-01-03T00:00:00Z\",\n \"receiptAmount\": {\n \"currencyCode\": \"IDR\",\n \"amount\": 2500000\n },\n \"provider\": {\n \"name\": \"Sample Clinic\",\n \"address\": \"1 Sample Street, Jakarta\",\n \"coordinates\": \"-6.200000,106.800000\"\n },\n \"doctors\": \"Dr. Sample\",\n \"diagnoses\": \"Sample diagnosis\",\n \"remarks\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Claims/SubmitClaim"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"data\": {\n \"claimNumber\": \"CL2601010000001H\"\n }\n}"},{"id":"5beabe4c-83e9-4bdd-abc1-933d5ff28e82","name":"Validation failure","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"benefitType\": \"INPATIENT\",\n \"dateOfAdmission\": \"2026-01-01T00:00:00Z\",\n \"dateOfDischarge\": \"2026-01-03T00:00:00Z\",\n \"receiptDate\": \"2026-01-03T00:00:00Z\",\n \"receiptAmount\": {\n \"currencyCode\": \"IDR\",\n \"amount\": 2500000\n },\n \"provider\": {\n \"name\": \"Sample Clinic\",\n \"address\": \"1 Sample Street, Jakarta\",\n \"coordinates\": \"-6.200000,106.800000\"\n },\n \"doctors\": \"Dr. Sample\",\n \"diagnoses\": \"Sample diagnosis\",\n \"remarks\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Claims/SubmitClaim"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": false,\n \"data\": \"Receipt amount must be greater than zero.\"\n}"}],"_postman_id":"95a8890d-3a67-464a-b5fd-068ae8b85dbb"},{"name":"Upload Docs","id":"97017c4b-1c5c-4153-9680-72a04088fe11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"files","type":"file","description":"

One or more files. Repeat this field per file.

\n","src":[]}]},"url":"{{base}}/{{apiVersion}}/api/Claims/Upload/:claimNumber","description":"

Attach supporting documents to a claim.

POST {{base}}/api/Claims/Upload/{claimNumber}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`multipart/form-data`
Envelope	Family B - `{\"isSuccess\", \"data\"}`

Description

Uploads one or more files against an existing claim - typically receipts and medical reports for a reimbursement raised with Submit Reimbursement.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	In	Type	Req.	Description
`claimNumber`	path	string	Yes	The claim to attach to.
`files`	form-data	file[]	Yes	One or more files. The form field must be named `files`, repeated once per file.
`Authorization`	header	string	Yes	`Bearer <token>`.

Send this as multipart/form-data, not JSON. Do not set Content-Type by hand - let your HTTP client set it with the boundary.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Processed. Check `isSuccess` - a downstream failure also returns `200`.
`400`	No file supplied. The body is the plain string `No file uploaded.`, not JSON.
`401`	Missing or expired token.

Response fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`isSuccess`	boolean	No	Whether the upload was accepted downstream.
`data`	object	Yes	Per-file outcome.

File types are not restricted by the API. The intended allow-list (PDF, JPEG, PNG, BMP, WebP) is not currently enforced, so validate on your side before uploading - an unexpected type will be accepted here and may fail later in processing.

\n","urlObject":{"path":["{{apiVersion}}","api","Claims","Upload",":claimNumber"],"host":["{{base}}"],"query":[],"variable":[{"description":{"content":"

The claim to attach documents to.

\n","type":"text/plain"},"type":"any","value":"CL2601010000001H","key":"claimNumber"}]}},"response":[{"id":"5afb4b23-eab9-4adc-a57a-d95570c165eb","name":"Files uploaded","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"files","type":"file","description":"One or more files. Repeat this field per file.","src":[]}]},"url":{"raw":"{{base}}/api/Claims/Upload/:claimNumber","host":["{{base}}"],"path":["api","Claims","Upload",":claimNumber"],"variable":[{"key":"claimNumber","value":"CL2601010000001H","description":"The claim to attach documents to."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"data\": {\n \"uploaded\": 1,\n \"files\": [\n { \"name\": \"receipt.pdf\", \"status\": \"VALID\" }\n ]\n }\n}"},{"id":"fa5c5d7d-0cc1-4f4c-a1a4-d7b8a9ef5ee1","name":"No file supplied - plain text body","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"files","type":"file","description":"One or more files. Repeat this field per file.","src":[]}]},"url":{"raw":"{{base}}/api/Claims/Upload/:claimNumber","host":["{{base}}"],"path":["api","Claims","Upload",":claimNumber"],"variable":[{"key":"claimNumber","value":"CL2601010000001H","description":"The claim to attach documents to."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"No file uploaded."}],"_postman_id":"97017c4b-1c5c-4153-9680-72a04088fe11"},{"name":"Download IGL","id":"216da932-17ce-41cb-b669-61cc2b9d7bbd","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"claimNumber\": \"CL2601010000001H\",\n \"email\": \"\",\n \"clientCode\": \"CLI01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/DownloadIGL","description":"

Download the Initial Guarantee Letter as a PDF.

POST {{base}}/api/Member/DownloadIGL

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Returns	`application/pdf` - a binary file, not JSON

Description

Returns the IGL for a claim as a PDF attachment named IGL_{glNumber}.pdf.

This endpoint does not return JSON. Do not attempt to parse the body - write it to a file or stream it to the user.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Description
`cardNumber`	string	Yes	Member's card number.
`claimNumber`	string	Yes	The claim whose IGL you want.
`email`	string	No	Caller's email, recorded downstream.
`clientCode`	string	No	Client code, where the downstream requires it.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Content-Type	Meaning
`200`	`application/pdf`	The IGL.
`404`	-	No IGL content available - either the claim has no initial guarantee letter yet, or the claim does not exist. The two cases are not distinguished.
`401`	-	Missing or expired token.

A 404 is the normal answer for a claim that has not reached IGL issue yet; it is not necessarily an error in your request.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"523f522d-2941-42db-a086-102b1051e12d","id":"523f522d-2941-42db-a086-102b1051e12d","name":"V1 & V2","type":"folder"}},"urlObject":{"path":["{{apiVersion}}","api","Member","DownloadIGL"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"95855746-035d-4283-9348-223ec08ebf5d","name":"PDF returned - binary body","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"claimNumber\": \"CL2601010000001H\",\n \"email\": \"\",\n \"clientCode\": \"CLI01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/DownloadIGL"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"92ef2f2e-10d6-468e-914d-65c4c623f47f","name":"No guarantee letter available","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"claimNumber\": \"CL2601010000001H\",\n \"email\": \"\",\n \"clientCode\": \"CLI01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/DownloadIGL"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"216da932-17ce-41cb-b669-61cc2b9d7bbd"},{"name":"Download FGL","id":"4c522d3f-9859-44a1-b593-7a86e478ca26","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"claimNumber\": \"CL2601010000001H\",\n \"email\": \"\",\n \"clientCode\": \"CLI01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/DownloadFGL","description":"

Download the Final Guarantee Letter as a PDF.

POST {{base}}/api/Member/DownloadFGL

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Returns	`application/pdf` - a binary file, not JSON

Description

Returns the FGL for a claim as a PDF attachment named FGL_{glNumber}.pdf. Same contract as DownloadIGL, but reads the final rather than the initial letter.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Description
`cardNumber`	string	Yes	Member's card number.
`claimNumber`	string	Yes	The claim whose FGL you want.
`email`	string	No	Caller's email, recorded downstream.
`clientCode`	string	No	Client code, where the downstream requires it.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Content-Type	Meaning
`200`	`application/pdf`	The FGL.
`404`	-	No FGL content available - typically the claim has not been finalised.
`401`	-	Missing or expired token.

A claim that has an IGL but no FGL yet returns 200 from DownloadIGL and 404 from this endpoint. That is expected.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"523f522d-2941-42db-a086-102b1051e12d","id":"523f522d-2941-42db-a086-102b1051e12d","name":"V1 & V2","type":"folder"}},"urlObject":{"path":["{{apiVersion}}","api","Member","DownloadFGL"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"d394f2a2-b7d3-4733-ba26-7e5c06abfb46","name":"PDF returned - binary body","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"claimNumber\": \"CL2601010000001H\",\n \"email\": \"\",\n \"clientCode\": \"CLI01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/DownloadFGL"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4df631ad-4516-4a6c-9f35-df5c67c6cc3c","name":"No guarantee letter available","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"claimNumber\": \"CL2601010000001H\",\n \"email\": \"\",\n \"clientCode\": \"CLI01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/DownloadFGL"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4c522d3f-9859-44a1-b593-7a86e478ca26"},{"name":"Validate Cashless Eligibility","id":"ce1ad6e8-1454-43ce-80e4-017cac4f70aa","request":{"method":"GET","header":[],"url":"{{base}}/{{apiVersion}}/api/Claims/ValidationCashless?ProviderCode=PRV001&CardNo=9999000000000001&Dob=1990-01-01","description":"

Check a member's cashless eligibility at a provider before creating a claim.

GET {{base}}/api/Claims/ValidationCashless

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Envelope	Family C - the payload is returned bare, with no wrapper

Description

The v1/v2 equivalent of V3's member-eligibility check. Confirms the member is in force and returns the benefit information a provider needs before submitting a cashless claim via SubmitClaimCashless.

Identify the member by either card number or policy number - at least one is required - plus date of birth and the provider code.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	In	Type	Req.	Description
`ProviderCode`	query	string	Yes	The provider checking eligibility.
`CardNo`	query	string	Conditional	Member's card number. Required unless `PolicyNo` is supplied.
`PolicyNo`	query	string	Conditional	Policy number. Required unless `CardNo` is supplied.
`Dob`	query	string	Yes	Member's date of birth.
`Authorization`	header	string	Yes	`Bearer <token>`.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Eligibility data, returned bare.
`500`	Also used for validation failures - see below.
`401`	Missing or expired token.

This endpoint reports missing parameters as HTTP 500

Unusually, a missing parameter does not return 400. It returns 500 with a plain-text body:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Body	Cause
`Please fill Card Number or Policy Number.`	Neither `CardNo` nor `PolicyNo` supplied.
`Please fill ProviderCode`	`ProviderCode` missing.
`Please fill Date Of Birth`	`Dob` missing.

A downstream refusal also returns 500, carrying the downstream reason as plain text. Do not assume a 500 here is a server fault - read the body, and treat a short plain-text body as a validation message rather than an outage.

The provider checking eligibility.

\n","type":"text/plain"},"key":"ProviderCode","value":"PRV001"},{"description":{"content":"

Member's card number. Required unless PolicyNo is supplied.

\n","type":"text/plain"},"key":"CardNo","value":"9999000000000001"},{"disabled":true,"description":{"content":"

Policy number. Required unless CardNo is supplied.

\n","type":"text/plain"},"key":"PolicyNo","value":""},{"description":{"content":"

Member's date of birth.

\n","type":"text/plain"},"key":"Dob","value":"1990-01-01"}],"variable":[]}},"response":[{"id":"4c387be1-7d26-4f9c-bd5b-06e953286228","name":"Eligible","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base}}/api/Claims/ValidationCashless?ProviderCode=PRV001&CardNo=9999000000000001&Dob=1990-01-01","host":["{{base}}"],"path":["api","Claims","ValidationCashless"],"query":[{"key":"ProviderCode","value":"PRV001","description":"The provider checking eligibility."},{"key":"CardNo","value":"9999000000000001","description":"Member's card number. Required unless PolicyNo is supplied."},{"key":"PolicyNo","value":"","description":"Policy number. Required unless CardNo is supplied.","disabled":true},{"key":"Dob","value":"1990-01-01","description":"Member's date of birth."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"cardNumber\": \"9999000000000001\",\n \"memberName\": \"John Doe\",\n \"policyNumber\": \"POL0000000000001\",\n \"memberStatus\": true,\n \"isSuspended\": false,\n \"planCode\": \"PLAN-001\",\n \"idBenefit\": 10000001,\n \"benefitCode\": \"IP\",\n \"benefitName\": \"INPATIENT\"\n}"},{"id":"95c1a050-4cec-4d98-ae94-4bc9c6a813bc","name":"Card and policy both missing - note HTTP 500","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base}}/api/Claims/ValidationCashless?ProviderCode=PRV001&CardNo=9999000000000001&Dob=1990-01-01","host":["{{base}}"],"path":["api","Claims","ValidationCashless"],"query":[{"key":"ProviderCode","value":"PRV001","description":"The provider checking eligibility."},{"key":"CardNo","value":"9999000000000001","description":"Member's card number. Required unless PolicyNo is supplied."},{"key":"PolicyNo","value":"","description":"Policy number. Required unless CardNo is supplied.","disabled":true},{"key":"Dob","value":"1990-01-01","description":"Member's date of birth."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"Please fill Card Number or Policy Number."},{"id":"117ef88a-aea2-40c5-9705-30de5788fb49","name":"ProviderCode missing - note HTTP 500","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base}}/api/Claims/ValidationCashless?ProviderCode=PRV001&CardNo=9999000000000001&Dob=1990-01-01","host":["{{base}}"],"path":["api","Claims","ValidationCashless"],"query":[{"key":"ProviderCode","value":"PRV001","description":"The provider checking eligibility."},{"key":"CardNo","value":"9999000000000001","description":"Member's card number. Required unless PolicyNo is supplied."},{"key":"PolicyNo","value":"","description":"Policy number. Required unless CardNo is supplied.","disabled":true},{"key":"Dob","value":"1990-01-01","description":"Member's date of birth."}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":"Please fill ProviderCode"}],"_postman_id":"ce1ad6e8-1454-43ce-80e4-017cac4f70aa"},{"name":"Submit Cashless Claim","id":"8ecb42dd-4832-4260-bca3-fb63e9006d8b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"cardNumber\": \"9999000000000001\",\n \"providerCode\": \"PRV001\",\n \"providerName\": \"Sample Clinic\",\n \"providerEmail\": \"provider@example.com\",\n \"providerAddress\": \"1 Sample Street\",\n \"providerCity\": \"Jakarta\",\n \"claimDate\": \"2026-01-01T00:00:00Z\",\n \"indate\": \"2026-01-01T00:00:00Z\",\n \"outdate\": null,\n \"polyCode\": \"POLY01\",\n \"polyName\": \"Sample Poly\",\n \"doctor\": \"Dr. Sample\",\n \"phone\": \"+628000000001\",\n \"medicalRecord\": \"\",\n \"referralSource\": \"\",\n \"icdCode1\": \"A09\",\n \"icdCode2\": \"\",\n \"icdCode3\": \"\",\n \"icdCode4\": \"\",\n \"los\": 0,\n \"stPost\": false,\n \"stPaid\": false,\n \"stExgratia\": false,\n \"descExgratia\": \"\",\n \"sickLeave\": 0,\n \"submitBy\": \"provider@example.com\",\n \"stHighPlan\": false,\n \"remark\": \"\",\n \"createdBy\": \"provider@example.com\",\n \"idBenefit\": 10000001,\n \"benefitCode\": \"IP\",\n \"benefitName\": \"INPATIENT\",\n \"treatmentType\": \"Rawat inap\",\n \"benefitDetail\": null,\n \"member\": {\n \"memberId\": \"00000000-0000-0000-0000-000000000001\",\n \"memberName\": \"John Doe\",\n \"cardNumber\": \"9999000000000001\",\n \"nik\": \"0000000000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"gender\": \"M\",\n \"maritalStatus\": \"S\",\n \"memberType\": \"Principal\",\n \"memberStatus\": true,\n \"isSuspended\": false,\n \"isVip\": 0,\n \"isAso\": false,\n \"isIndividual\": false,\n \"joinDate\": \"2026-01-01T00:00:00Z\",\n \"policyNumber\": \"POL0000000000001\",\n \"policyStart\": \"2026-01-01T00:00:00Z\",\n \"policyEnd\": \"2026-12-31T00:00:00Z\",\n \"planCode\": \"PLAN-001\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Claims/SubmitClaimCashless","description":"

Submit a cashless claim on behalf of a provider.

POST {{base}}/api/Claims/SubmitClaimCashless

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Envelope	Family B - `{\"isSuccess\", \"data\", \"message\"}`

Description

Creates a cashless claim. Run ValidationCashless first - it confirms the member is in force and supplies the benefit identifiers this call needs.

For reimbursement claims use Submit Reimbursement (Claims/SubmitClaim) instead; the two are separate flows with different payloads.

Request body

Required:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Format	Description
`cardNumber`	string	-	Member's card number.
`providerCode`	string	-	Provider submitting the claim.
`providerName`	string	-	Provider name.
`providerAddress`	string	-	Provider address.
`providerCity`	string	-	Provider city.
`claimDate`	string	date-time	When the claim is raised.
`treatmentType`	string	-	Treatment type.
`createdBy`	string	-	Who submitted it.
`idBenefit`	integer	-	Benefit identifier from ValidationCashless.
`member`	object	-	Member snapshot - see below.

Optional: id (defaults 0), providerEmail, indate, outdate, polyCode, polyName, doctor, phone, medicalRecord, referralSource, icdCode1-icdCode4, los, stPost, stPaid, stExgratia, descExgratia, sickLeave, submitBy, stHighPlan, remark, benefitCode, benefitName, benefitDetail.

The four st* booleans (stPost, stPaid, stExgratia, stHighPlan) all default to false.

member - required: memberId, memberName, cardNumber, dateOfBirth (yyyy-MM-dd), gender, memberType, memberStatus (bool), isSuspended (bool), joinDate, policyNumber, policyStart, policyEnd, planCode. Optional: nik, maritalStatus, isVip (int, defaults 0), isAso, isIndividual.

benefitDetail carries the benefit structure and per-sub-benefit claim values, in the same shape ValidationCashless returns.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Submitted. Check `isSuccess` - a downstream refusal also returns `200`.
`400`	Validation failure.
`401`	Missing or expired token.

Response fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`isSuccess`	boolean	No	The authority on whether the claim was accepted.
`message`	string	Yes	Downstream message, including the refusal reason when `isSuccess` is `false`.
`data`	object	Yes	The created claim, including its claim number.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"523f522d-2941-42db-a086-102b1051e12d","id":"523f522d-2941-42db-a086-102b1051e12d","name":"V1 & V2","type":"folder"}},"urlObject":{"path":["{{apiVersion}}","api","Claims","SubmitClaimCashless"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"43834066-7565-4fea-b993-51b5cd9f5054","name":"Claim created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"cardNumber\": \"9999000000000001\",\n \"providerCode\": \"PRV001\",\n \"providerName\": \"Sample Clinic\",\n \"providerEmail\": \"provider@example.com\",\n \"providerAddress\": \"1 Sample Street\",\n \"providerCity\": \"Jakarta\",\n \"claimDate\": \"2026-01-01T00:00:00Z\",\n \"indate\": \"2026-01-01T00:00:00Z\",\n \"outdate\": null,\n \"polyCode\": \"POLY01\",\n \"polyName\": \"Sample Poly\",\n \"doctor\": \"Dr. Sample\",\n \"phone\": \"+628000000001\",\n \"medicalRecord\": \"\",\n \"referralSource\": \"\",\n \"icdCode1\": \"A09\",\n \"icdCode2\": \"\",\n \"icdCode3\": \"\",\n \"icdCode4\": \"\",\n \"los\": 0,\n \"stPost\": false,\n \"stPaid\": false,\n \"stExgratia\": false,\n \"descExgratia\": \"\",\n \"sickLeave\": 0,\n \"submitBy\": \"provider@example.com\",\n \"stHighPlan\": false,\n \"remark\": \"\",\n \"createdBy\": \"provider@example.com\",\n \"idBenefit\": 10000001,\n \"benefitCode\": \"IP\",\n \"benefitName\": \"INPATIENT\",\n \"treatmentType\": \"Rawat inap\",\n \"benefitDetail\": null,\n \"member\": {\n \"memberId\": \"00000000-0000-0000-0000-000000000001\",\n \"memberName\": \"John Doe\",\n \"cardNumber\": \"9999000000000001\",\n \"nik\": \"0000000000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"gender\": \"M\",\n \"maritalStatus\": \"S\",\n \"memberType\": \"Principal\",\n \"memberStatus\": true,\n \"isSuspended\": false,\n \"isVip\": 0,\n \"isAso\": false,\n \"isIndividual\": false,\n \"joinDate\": \"2026-01-01T00:00:00Z\",\n \"policyNumber\": \"POL0000000000001\",\n \"policyStart\": \"2026-01-01T00:00:00Z\",\n \"policyEnd\": \"2026-12-31T00:00:00Z\",\n \"planCode\": \"PLAN-001\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Claims/SubmitClaimCashless"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"message\": \"SUCCESS\",\n \"data\": {\n \"claimNumber\": \"CL2601010000001H\"\n }\n}"},{"id":"a1f66ded-1c75-401f-8f47-8ff65ed6e5da","name":"Refused - note HTTP 200 with isSuccess false","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"cardNumber\": \"9999000000000001\",\n \"providerCode\": \"PRV001\",\n \"providerName\": \"Sample Clinic\",\n \"providerEmail\": \"provider@example.com\",\n \"providerAddress\": \"1 Sample Street\",\n \"providerCity\": \"Jakarta\",\n \"claimDate\": \"2026-01-01T00:00:00Z\",\n \"indate\": \"2026-01-01T00:00:00Z\",\n \"outdate\": null,\n \"polyCode\": \"POLY01\",\n \"polyName\": \"Sample Poly\",\n \"doctor\": \"Dr. Sample\",\n \"phone\": \"+628000000001\",\n \"medicalRecord\": \"\",\n \"referralSource\": \"\",\n \"icdCode1\": \"A09\",\n \"icdCode2\": \"\",\n \"icdCode3\": \"\",\n \"icdCode4\": \"\",\n \"los\": 0,\n \"stPost\": false,\n \"stPaid\": false,\n \"stExgratia\": false,\n \"descExgratia\": \"\",\n \"sickLeave\": 0,\n \"submitBy\": \"provider@example.com\",\n \"stHighPlan\": false,\n \"remark\": \"\",\n \"createdBy\": \"provider@example.com\",\n \"idBenefit\": 10000001,\n \"benefitCode\": \"IP\",\n \"benefitName\": \"INPATIENT\",\n \"treatmentType\": \"Rawat inap\",\n \"benefitDetail\": null,\n \"member\": {\n \"memberId\": \"00000000-0000-0000-0000-000000000001\",\n \"memberName\": \"John Doe\",\n \"cardNumber\": \"9999000000000001\",\n \"nik\": \"0000000000000001\",\n \"dateOfBirth\": \"1990-01-01\",\n \"gender\": \"M\",\n \"maritalStatus\": \"S\",\n \"memberType\": \"Principal\",\n \"memberStatus\": true,\n \"isSuspended\": false,\n \"isVip\": 0,\n \"isAso\": false,\n \"isIndividual\": false,\n \"joinDate\": \"2026-01-01T00:00:00Z\",\n \"policyNumber\": \"POL0000000000001\",\n \"policyStart\": \"2026-01-01T00:00:00Z\",\n \"policyEnd\": \"2026-12-31T00:00:00Z\",\n \"planCode\": \"PLAN-001\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Claims/SubmitClaimCashless"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": false,\n \"message\": \"Exclusion/Member Nonactive.\",\n \"data\": null\n}"}],"_postman_id":"8ecb42dd-4832-4260-bca3-fb63e9006d8b"},{"name":"Get Claims by Claim Number","id":"f7b0b6d5-2601-4d34-a0be-1ada0884a26a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"claimNumber\": [\"CL2601010000001H\", \"CL2601010000002H\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Claims/GetListDataByClaimNumber","description":"

Read several claims at once by claim number.

POST {{base}}/api/Claims/GetListDataByClaimNumber

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`

Description

Batch alternative to Detail Claim: pass up to five claim numbers and get their data back in one call, without needing each member's card number.

Responses are localised - send Accept-Language to choose the language of status labels and descriptions.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	In	Type	Req.	Description
`claimNumber`	body	string[]	Yes	The claim numbers to read. Maximum 5.
`Accept-Language`	header	string	No	e.g. `id-ID` or `en-US`. Controls the language of labels.
`Authorization`	header	string	Yes	`Bearer <token>`.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	The claims.
`400`	The array was empty, or contained more than 5 claim numbers.
`401`	Missing or expired token.

The five-item cap is enforced in the handler - a sixth entry fails the whole request rather than being truncated. Batch your reads accordingly.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"523f522d-2941-42db-a086-102b1051e12d","id":"523f522d-2941-42db-a086-102b1051e12d","name":"V1 & V2","type":"folder"}},"urlObject":{"path":["{{apiVersion}}","api","Claims","GetListDataByClaimNumber"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"58361c94-4825-4eab-8899-e43b2cbfba84","name":"Claims returned","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"claimNumber\": [\"CL2601010000001H\", \"CL2601010000002H\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Claims/GetListDataByClaimNumber"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"data\": [\n {\n \"claimNumber\": \"CL2601010000001H\",\n \"claimStatus\": \"Admission Review\",\n \"claimStatusCode\": 4\n }\n ]\n}"},{"id":"930aff99-56a9-4ff1-9212-632a4b25f574","name":"More than five claim numbers","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"claimNumber\": [\"CL2601010000001H\", \"CL2601010000002H\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Claims/GetListDataByClaimNumber"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"errors\": {\n \"cardNumber\": [\n \"The cardNumber field is required.\"\n ]\n },\n \"traceId\": \"00-00000000000000000000000000000000-0000000000000000-00\"\n}"}],"_postman_id":"f7b0b6d5-2601-4d34-a0be-1ada0884a26a"},{"name":"List Claims by Corporate Code","id":"aaee3eb1-555e-4088-b263-750b425ca201","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": [\"CORP01\", \"CORP02\"],\n \"page\": { \"page\": 1, \"pageSize\": 10 }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Claims/ListByCorporateCode","description":"

List claims across one or many corporate codes.

POST {{base}}/api/Claims/ListByCorporateCode

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Envelope	Family D - `{\"isSuccess\", \"message\", \"data\", \"page\"}`

Description

Corporate-scoped claim listing, the claims counterpart of Member/ListByCorporateCode. Accepts several corporate codes in one call, processes them in parallel and returns the results grouped by code.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Default	Description
`corporateCode`	string or string[]	No	-	One corporate code, or several. Both forms are accepted.
`page`	object	No	-	Paging.
`page.page`	integer	No	`1`	Page number.
`page.pageSize`	integer	No	`10`	Page size.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Claims, grouped by corporate code.
`400`	Malformed body.
`401`	Missing or expired token.

Response fields

Fields are omitted when null on this family - which keys appear depends on whether you asked for one code or several. Test for key presence.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Present	Description
`isSuccess`	boolean	Always	Whether the call succeeded.
`message`	string	Always	Summary message.
`title`	string	Always	Result title.
`data.corporateCode`, `data.corporateName`	string	Single code only	The code queried.
`data.claims`	array	Single code only	The page of claims.
`data.pagination`	object	Single code only	`{ totalItems, totalPages, currentPage, pageSize }`.
`data.corporateCodeGroups`	array	Always	Per-code groups, each with its own `claims` and `pagination`.
`data.errors`	array	Only on partial failure	`[{ corporateCode, error }]`.
`page`	object	Single code only	Top-level paging.

A partial failure still returns 200 with isSuccess: true - always inspect data.errors.

data.claims[] - id (integer), dob, insuranceNumber, polisNumber, memberNumber, cardNumber, memberName, claimStatus, prevStatus, claimStatusGroup, claimNo, claimSource, customerName, customerCode, holdingName, holdingCode, planDetailCode, planNameDetail, providerCode, providerName, claimDate, admisionDate, dischargeDate, claimType, remark, totalPaid, totalExcess, totalClaim, diagnoseCode, diagnoseDesc. Everything except id is nullable. admisionDate is spelled with one d - that is the real field name.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"523f522d-2941-42db-a086-102b1051e12d","id":"523f522d-2941-42db-a086-102b1051e12d","name":"V1 & V2","type":"folder"}},"urlObject":{"path":["{{apiVersion}}","api","Claims","ListByCorporateCode"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"ae37abb5-e3d6-4cbd-b546-fc261348388a","name":"Grouped by corporate code","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": [\"CORP01\", \"CORP02\"],\n \"page\": { \"page\": 1, \"pageSize\": 10 }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Claims/ListByCorporateCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"message\": \"SUCCESS\",\n \"data\": {\n \"corporateCodeGroups\": [\n {\n \"corporateCode\": \"CORP01\",\n \"corporateName\": \"Sample Corporate\",\n \"claims\": [],\n \"pagination\": {\n \"totalItems\": 0,\n \"totalPages\": 0,\n \"currentPage\": 1,\n \"pageSize\": 10\n }\n }\n ]\n }\n}"},{"id":"c78c480e-5cb3-4698-af29-4e23eef697bb","name":"Partial failure - note HTTP 200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": [\"CORP01\", \"CORP02\"],\n \"page\": { \"page\": 1, \"pageSize\": 10 }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Claims/ListByCorporateCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"message\": \"One or more corporate codes could not be read.\",\n \"data\": {\n \"corporateCodeGroups\": [],\n \"errors\": [\n { \"corporateCode\": \"CORP02\", \"error\": \"Corporate code not found.\" }\n ]\n }\n}"}],"_postman_id":"aaee3eb1-555e-4088-b263-750b425ca201"},{"name":"Policy Details","id":"d9c81bde-b6aa-4a5c-a72f-80c379e33a3d","request":{"method":"GET","header":[],"url":"{{base}}/{{apiVersion}}/api/Claims/PolicyDetails?type=TERMS&productId=1","description":"

Read the terms and benefit details of a product.

GET {{base}}/api/Claims/PolicyDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Envelope	Family B - `{\"isSuccess\", \"data\", \"message\"}`

Description

Returns the configured detail for a product - the benefit structure and terms behind a member's plan. Useful for rendering policy wording without holding a copy yourself.

Responses are localised: send Accept-Language and the terms come back in that language.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	In	Type	Req.	Description
`type`	query	string	Yes	The kind of detail to return.
`productId`	query	integer	Yes	The product to read.
`Accept-Language`	header	string	No	e.g. `id-ID` or `en-US`. Controls the language of the returned terms.
`Authorization`	header	string	Yes	`Bearer <token>`.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	The product detail, with `isSuccess: true`.
`400`	Not found or downstream refusal. Carries the same `{\"isSuccess\": false, …}` body rather than an error shape.
`400`	On an unhandled exception, an RFC 7807-style body with `errors.Message` and a `traceId`.
`401`	Missing or expired token.

Response fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`isSuccess`	boolean	No	Whether the lookup succeeded.
`message`	string	Yes	Downstream message.
`data`	object	Yes	The product detail. Shape varies with `type`.

data is loosely typed downstream, so its shape depends on the type you ask for. Treat it as opaque unless you have agreed a specific type with the integration team.

The kind of detail to return.

\n","type":"text/plain"},"key":"type","value":"TERMS"},{"description":{"content":"

The product to read.

\n","type":"text/plain"},"key":"productId","value":"1"}],"variable":[]}},"response":[{"id":"a8a3a82a-946a-41b7-841d-c25fad0ced6d","name":"Product detail","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base}}/api/Claims/PolicyDetails?type=TERMS&productId=1","host":["{{base}}"],"path":["api","Claims","PolicyDetails"],"query":[{"key":"type","value":"TERMS","description":"The kind of detail to return."},{"key":"productId","value":"1","description":"The product to read."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"message\": \"SUCCESS\",\n \"data\": {\n \"productId\": 1,\n \"type\": \"TERMS\",\n \"content\": []\n }\n}"},{"id":"d83c0b83-7681-4534-b464-be8fd59a6f13","name":"Not found - note same body shape","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base}}/api/Claims/PolicyDetails?type=TERMS&productId=1","host":["{{base}}"],"path":["api","Claims","PolicyDetails"],"query":[{"key":"type","value":"TERMS","description":"The kind of detail to return."},{"key":"productId","value":"1","description":"The product to read."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": false,\n \"message\": \"Product not found.\",\n \"data\": null\n}"}],"_postman_id":"d9c81bde-b6aa-4a5c-a72f-80c379e33a3d"}],"id":"4f74f715-0d45-44be-ba17-1c7e69b238c1","description":"

Submit claims and read claim data.

These endpoints do not use the data envelope - each returns its payload at the top level under a resource-specific key (listGL, claims). Check each endpoint's documentation for its root key.

\n","_postman_id":"4f74f715-0d45-44be-ba17-1c7e69b238c1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"523f522d-2941-42db-a086-102b1051e12d","id":"523f522d-2941-42db-a086-102b1051e12d","name":"V1 & V2","type":"folder"}}},{"name":"Submit Claim History","item":[{"name":"Submit Claim History","id":"f5e466f3-e6b2-40b3-817e-cc0ad3f038b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"header\": [\n {\n \"insuredNo\": \"INS00000001\",\n \"insuredNoTpa\": \"\",\n \"registrationType\": \"\",\n \"claimId\": \"0001/CLA/01/2026\",\n \"otherRelatedClaimId\": \"0001/CLA/01/2026\",\n \"policyNo\": \"POL0000000000001\",\n \"insuredName\": \"John Doe\"\n }\n ],\n \"detail\": [\n {\n \"claimId\": \"0001/CLA/01/2026\",\n \"benefitCode\": \"IP\",\n \"amount\": 2500000\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Claims/HistoryClaim","description":"

Submit historical claim records in bulk.

POST {{base}}/api/Claims/HistoryClaim

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Envelope	Family B - `{\"isSuccess\", \"data\"}`

Description

Seeds a client's prior claim history, typically at onboarding, so that limits and pre-existing conditions are calculated correctly from day one.

Added in 2.7.0 (Oct 2025), which also improved throughput on this endpoint.

The payload is a pair of arrays: one header row per claim, and one or more detail rows per claim, linked by the claim identifier.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Description
`header`	array	Yes	One entry per historical claim.
`detail`	array	Yes	Line items belonging to those claims.

header[] carries the claim-level facts - insuredNo, insuredNoTpa, registrationType, claimId, otherRelatedClaimId, policyNo, insuredName and the remaining claim header fields. detail[] carries the per-line amounts and benefit references, joined to the header by claimId.

Submit header and detail together in one call; detail rows whose claimId has no matching header are rejected.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Processed. Check `isSuccess` - a partial or total rejection also returns `200`.
`400`	Malformed payload.
`401`	Missing or expired token.

Response fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`isSuccess`	boolean	No	Whether the batch was accepted.
`data`	object	Yes	Per-row outcomes, including any rejected rows and why.

Inspect data even on a 200 with isSuccess: true - individual rows can be reported as skipped.

\n","urlObject":{"path":["{{apiVersion}}","api","Claims","HistoryClaim"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"49823c8f-0cbd-496e-8a21-c33526339980","name":"History accepted","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"header\": [\n {\n \"insuredNo\": \"INS00000001\",\n \"insuredNoTpa\": \"\",\n \"registrationType\": \"\",\n \"claimId\": \"0001/CLA/01/2026\",\n \"otherRelatedClaimId\": \"0001/CLA/01/2026\",\n \"policyNo\": \"POL0000000000001\",\n \"insuredName\": \"John Doe\"\n }\n ],\n \"detail\": [\n {\n \"claimId\": \"0001/CLA/01/2026\",\n \"benefitCode\": \"IP\",\n \"amount\": 2500000\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Claims/HistoryClaim"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"data\": {\n \"headerProcessed\": 1,\n \"detailProcessed\": 1,\n \"rejected\": []\n }\n}"},{"id":"d925252c-3ef0-40c1-b877-e3acb693bca3","name":"Partial rejection - note HTTP 200","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"header\": [\n {\n \"insuredNo\": \"INS00000001\",\n \"insuredNoTpa\": \"\",\n \"registrationType\": \"\",\n \"claimId\": \"0001/CLA/01/2026\",\n \"otherRelatedClaimId\": \"0001/CLA/01/2026\",\n \"policyNo\": \"POL0000000000001\",\n \"insuredName\": \"John Doe\"\n }\n ],\n \"detail\": [\n {\n \"claimId\": \"0001/CLA/01/2026\",\n \"benefitCode\": \"IP\",\n \"amount\": 2500000\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Claims/HistoryClaim"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"data\": {\n \"headerProcessed\": 1,\n \"detailProcessed\": 0,\n \"rejected\": [\n { \"claimId\": \"0001/CLA/01/2026\", \"reason\": \"No matching header for detail row.\" }\n ]\n }\n}"}],"_postman_id":"f5e466f3-e6b2-40b3-817e-cc0ad3f038b6"}],"id":"213a7f10-5a9b-4cf3-9b43-10d2ffc36716","description":"

Submit historical claim records in bulk, as paired header and detail rows.

Used at onboarding to seed a client's prior claim history.

\n","_postman_id":"213a7f10-5a9b-4cf3-9b43-10d2ffc36716","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"523f522d-2941-42db-a086-102b1051e12d","id":"523f522d-2941-42db-a086-102b1051e12d","name":"V1 & V2","type":"folder"}}},{"name":"Member","item":[{"name":"List Member by Client Code","id":"90bd36a2-ff9c-4259-93ca-052765319758","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"CLI01\",\n \"page\": { \"page\": 1, \"pageSize\": 10, \"query\": \"\" }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/ListMemberByClientCode","description":"

List the members belonging to a client code.

POST {{base}}/api/Member/ListMemberByClientCode

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Envelope	Family B - `{\"isSuccess\": …, \"data\": …}`

Description

Returns a paged list of members under one client code. The client code is the insurer/client identifier issued with your keys - it is the same value your token is scoped to.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Default	Description
`clientCode`	string	Yes	-	The client/insurer code to list members for.
`page`	object	No	-	Paging. Omit for defaults.
`page.page`	integer	No	`1`	Page number.
`page.pageSize`	integer	No	`10`	Page size.
`page.query`	string	No	`null`	Free-text search across the member list.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	The page of members.
`400`	`clientCode` missing - RFC 7807 with `traceId`.
`401`	Missing or expired token.

Response fields

The payload is nested twice - data.data.items, not data.items. This is the only endpoint in the folder shaped this way.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`isSuccess`	boolean	No	Whether the downstream call succeeded. Check this, not just the status code.
`data`	object	No	Outer wrapper.
`data.message`	string	Yes	Downstream message.
`data.data`	object	No	Inner wrapper.
`data.data.items`	array	No	The page of member records.
`data.data.totalRecords`	integer	No	Total matching members across all pages.
`data.data.totalPages`	integer	No	Total pages available.

Note there is no echo of the page number or page size in the response - track them on your side.

\n","urlObject":{"path":["{{apiVersion}}","api","Member","ListMemberByClientCode"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"1783fdef-ca7f-4b72-8ee9-64dcf05f4014","name":"Page of members","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJOb3ZhVXNlcklkIjoiR0xPQkFMIiwiTm92YUhlYWRlclRva2VuIjoiQ0gwMDI1IiwiTm92YVVzZXJUb2tlbiI6IkNIMDAyNSIsIk5vdmFDbGllbnRJZCI6IkdMT0JBTCIsImV4cCI6MTc0ODQwODc4MiwiaXNzIjoiand0LWlzc3VlciIsImF1ZCI6Imp3dC1hdWRpZW5jZSJ9.YAaDWvKG6LaHQOVhuOHxfxIe9puC45k6Am8xuWlHwq0"}},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"CLI01\",\n \"page\": { \"page\": 1, \"pageSize\": 10, \"query\": \"\" }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/ListMemberByClientCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"data\": {\n \"message\": \"SUCCESS\",\n \"data\": {\n \"items\": [\n {\n \"memberNumber\": \"MEM00000001\",\n \"memberName\": \"John Doe\",\n \"cardNumber\": \"9999000000000001\",\n \"policyNumber\": \"POL0000000000001\"\n }\n ],\n \"totalRecords\": 1,\n \"totalPages\": 1\n }\n }\n}"},{"id":"cb6db54d-792c-4511-9530-9a51da03a2de","name":"clientCode missing","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJOb3ZhVXNlcklkIjoiR0xPQkFMIiwiTm92YUhlYWRlclRva2VuIjoiQ0gwMDI1IiwiTm92YVVzZXJUb2tlbiI6IkNIMDAyNSIsIk5vdmFDbGllbnRJZCI6IkdMT0JBTCIsImV4cCI6MTc0ODQwODc4MiwiaXNzIjoiand0LWlzc3VlciIsImF1ZCI6Imp3dC1hdWRpZW5jZSJ9.YAaDWvKG6LaHQOVhuOHxfxIe9puC45k6Am8xuWlHwq0"}},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"CLI01\",\n \"page\": { \"page\": 1, \"pageSize\": 10, \"query\": \"\" }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/ListMemberByClientCode"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"errors\": {\n \"cardNumber\": [\n \"The cardNumber field is required.\"\n ]\n },\n \"traceId\": \"00-00000000000000000000000000000000-0000000000000000-00\"\n}"}],"_postman_id":"90bd36a2-ff9c-4259-93ca-052765319758"},{"name":"Member Information by Card Number","id":"606b55ec-5edd-474f-8750-0863c7663896","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"accept","value":"*/*"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJOb3ZhVXNlcklkIjoiMTE0NjIiLCJOb3ZhSGVhZGVyVG9rZW4iOiJiZWFyZXJfcjMwMzZWRkE0VHpHTkJEL1BVcTQwQUZ3MjY4VU5pYmJTSVYyd3ZSUU16RT0iLCJOb3ZhVXNlclRva2VuIjoiRUI4M0RDQUMtOEZBNS00REVBLTk1Q0YtRDcxQUNBMURDQzMxIiwiTm92YUNsaWVudElkIjoiMjIxMTAwMDkiLCJleHAiOjE3MjgwMzQ2MzgsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3QvIiwiYXVkIjoiaHR0cDovL2xvY2FsaG9zdC8ifQ.jzG_t-13xCIfYgUKwxxMrRHXFhPOQt33oxQ2EBv0ANY"}],"url":"{{base}}/{{apiVersion}}/api/Member/FindByCardNumber/:cardNumber","description":"

Look up one member by card number, with their family and card artwork.

GET {{base}}/api/Member/FindByCardNumber/{cardNo}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Envelope	Family C - no envelope; three root keys

Description

The primary member lookup. Returns the member, their family members, and the resources needed to render a digital membership card.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	In	Type	Req.	Description
`cardNo`	path	string	Yes	Member's card number.
`Authorization`	header	string	Yes	`Bearer <token>`.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	The member.
`400`	Not found - `{\"Status\":400,\"Errors\":[{\"ErrorCode\":\"InternalServerError\",\"Message\":\"Data not found.\"}]}`. Note the misleading error code.
`401`	Missing or expired token.

Response fields

Three root keys, no data wrapper.

member

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`memberNumber`	string	Yes	Your identifier for the member.
`memberId`	string	Yes	Internal member ID.
`cardNumber`	string	Yes	Card number.
`memberName`	string	Yes	Full name.
`insuranceNumber`	string	Yes	Insurer's member reference.
`sex`	string	Yes	`M` / `F`.
`clientName`, `clientCode`	string	Yes	Insurer/client.
`corporateName`, `corporateCode`	string	Yes	Corporate.
`memberType`	string	Yes	e.g. `Principal`.
`dob`	string	Yes	Date of birth.
`isActive`	boolean	No	Whether cover is in force.
`policyNumber`	string	Yes	Policy number.
`paymentAccount`	string	Yes	Reimbursement account number.
`bankName`	string	Yes	Reimbursement bank.

familyMember[] - memberName string, memberNumber string, memberType string, isPrincipal boolean. Empty array when the member has no family on the policy.

resource - card rendering assets: urlRender, urlBack, urlBackground (strings) and template (array). Not needed unless you are displaying a digital card.

\n","urlObject":{"path":["{{apiVersion}}","api","Member","FindByCardNumber",":cardNumber"],"host":["{{base}}"],"query":[],"variable":[{"description":{"content":"

Member's card number.

\n","type":"text/plain"},"type":"any","value":"9999000000000001","key":"cardNumber"}]}},"response":[{"id":"42a8e238-333f-4a77-a7fd-f38587bb4622","name":"Member found","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"GET","header":[{"key":"accept","value":"*/*"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJOb3ZhVXNlcklkIjoiMTE0NjIiLCJOb3ZhSGVhZGVyVG9rZW4iOiJiZWFyZXJfcjMwMzZWRkE0VHpHTkJEL1BVcTQwQUZ3MjY4VU5pYmJTSVYyd3ZSUU16RT0iLCJOb3ZhVXNlclRva2VuIjoiRUI4M0RDQUMtOEZBNS00REVBLTk1Q0YtRDcxQUNBMURDQzMxIiwiTm92YUNsaWVudElkIjoiMjIxMTAwMDkiLCJleHAiOjE3MjgwMzQ2MzgsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3QvIiwiYXVkIjoiaHR0cDovL2xvY2FsaG9zdC8ifQ.jzG_t-13xCIfYgUKwxxMrRHXFhPOQt33oxQ2EBv0ANY"}],"url":{"raw":"{{base}}/api/Member/FindByCardNumber/:cardNumber","host":["{{base}}"],"path":["api","Member","FindByCardNumber",":cardNumber"],"variable":[{"key":"cardNumber","value":"9999000000000001","description":"Member's card number."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"member\": {\n \"memberNumber\": \"MEM00000001\",\n \"memberId\": \"00000000-0000-0000-0000-000000000001\",\n \"cardNumber\": \"9999000000000001\",\n \"memberName\": \"John Doe\",\n \"insuranceNumber\": \"INS00000001\",\n \"sex\": \"M\",\n \"clientName\": \"Sample Insurance\",\n \"clientCode\": \"CLI01\",\n \"corporateName\": \"Sample Corporate\",\n \"corporateCode\": \"CORP01\",\n \"memberType\": \"Principal\",\n \"dob\": \"1990-01-01\",\n \"isActive\": true,\n \"policyNumber\": \"POL0000000000001\",\n \"paymentAccount\": \"0000000001\",\n \"bankName\": \"Sample Bank\"\n },\n \"familyMember\": [\n {\n \"memberName\": \"Jane Doe\",\n \"memberNumber\": \"MEM00000002\",\n \"memberType\": \"Spouse\",\n \"isPrincipal\": false\n }\n ],\n \"resource\": {\n \"urlRender\": \"https://example.com/card/render\",\n \"urlBack\": \"https://example.com/card/back\",\n \"urlBackground\": \"https://example.com/card/bg\",\n \"template\": []\n }\n}"},{"id":"8088b252-88c1-40a9-8ebd-d1bf5bb9e866","name":"Not found","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"GET","header":[{"key":"accept","value":"*/*"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJOb3ZhVXNlcklkIjoiMTE0NjIiLCJOb3ZhSGVhZGVyVG9rZW4iOiJiZWFyZXJfcjMwMzZWRkE0VHpHTkJEL1BVcTQwQUZ3MjY4VU5pYmJTSVYyd3ZSUU16RT0iLCJOb3ZhVXNlclRva2VuIjoiRUI4M0RDQUMtOEZBNS00REVBLTk1Q0YtRDcxQUNBMURDQzMxIiwiTm92YUNsaWVudElkIjoiMjIxMTAwMDkiLCJleHAiOjE3MjgwMzQ2MzgsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3QvIiwiYXVkIjoiaHR0cDovL2xvY2FsaG9zdC8ifQ.jzG_t-13xCIfYgUKwxxMrRHXFhPOQt33oxQ2EBv0ANY"}],"url":{"raw":"{{base}}/api/Member/FindByCardNumber/:cardNumber","host":["{{base}}"],"path":["api","Member","FindByCardNumber",":cardNumber"],"variable":[{"key":"cardNumber","value":"9999000000000001","description":"Member's card number."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"InternalServerError\",\n \"Message\": \"Data not found.\"\n }\n ]\n}"}],"_postman_id":"606b55ec-5edd-474f-8750-0863c7663896"},{"name":"Member Benefit by Card Number","id":"5c6144a4-0cee-4ca6-81ac-8b2ba3543426","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"accept","value":"*/*"},{"key":"Accept-Language","value":"","type":"text"},{"key":"Authorization","value":"","type":"text"}],"url":"{{base}}/{{apiVersion}}/api/Member/GetBenefitsByCardNumber/:cardNumber","description":"

Read a member's plans, limits and eligible providers.

GET {{base}}/api/Member/GetBenefitsByCardNumber/{cardNo}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Envelope	Family C - no envelope; root key `plans`

Description

Returns the benefit structure attached to a member's card: one entry per plan, with its annual limit, validity dates and the providers the plan can be used at.

Added in 2.6.1 (Feb 2025).

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	In	Type	Req.	Description
`cardNo`	path	string	Yes	Member's card number.
`Authorization`	header	string	Yes	`Bearer <token>`.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	The member's plans.
`400`	Not found - `{\"Status\":400,\"Errors\":[…]}`.
`401`	Missing or expired token.

Response fields - `plans[]`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`planCode`	string	Yes	Plan code.
`planName`	string	Yes	Plan name.
`planAnnualLimit`	number	Yes	Annual limit in the plan's currency.
`planLimitType`	string	Yes	How the limit applies, e.g. per year or per visit.
`benefitCode`	string	Yes	Benefit code.
`benefitType`	object	Yes	`{ type, display }` - e.g. `INPATIENT`.
`planStart`, `planEnd`	string	Yes	Plan validity dates.
`providerList`	array	Yes	Providers this plan may be used at. Can be large.

plans is an empty array when the member holds no active plan - that is a 200, not an error.

\n","urlObject":{"path":["{{apiVersion}}","api","Member","GetBenefitsByCardNumber",":cardNumber"],"host":["{{base}}"],"query":[],"variable":[{"description":{"content":"

Member's card number.

\n","type":"text/plain"},"type":"any","value":"9999000000000001","key":"cardNumber"}]}},"response":[{"id":"bfb1066b-7764-4b6e-8059-6db6d79e24ae","name":"Plans returned","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"GET","header":[{"key":"accept","value":"*/*"},{"key":"Accept-Language","value":"","type":"text"},{"key":"Authorization","value":"","type":"text"}],"url":{"raw":"{{base}}/api/Member/GetBenefitsByCardNumber/:cardNumber","host":["{{base}}"],"path":["api","Member","GetBenefitsByCardNumber",":cardNumber"],"variable":[{"key":"cardNumber","value":"9999000000000001","description":"Member's card number."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"plans\": [\n {\n \"planAnnualLimit\": 30000000,\n \"planLimitType\": \"ANNUAL\",\n \"planCode\": \"PLAN-001\",\n \"planName\": \"Sample Inpatient Plan (PLAN-001)\",\n \"benefitType\": {\n \"type\": \"INPATIENT\",\n \"display\": \"INPATIENT\"\n },\n \"benefitCode\": \"IP\",\n \"planStart\": \"2026-01-01\",\n \"planEnd\": \"2026-12-31\",\n \"providerList\": []\n }\n ]\n}"},{"id":"f8cca591-3441-4a20-83cc-dd83d096c8e0","name":"No active plan","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"GET","header":[{"key":"accept","value":"*/*"},{"key":"Accept-Language","value":"","type":"text"},{"key":"Authorization","value":"","type":"text"}],"url":{"raw":"{{base}}/api/Member/GetBenefitsByCardNumber/:cardNumber","host":["{{base}}"],"path":["api","Member","GetBenefitsByCardNumber",":cardNumber"],"variable":[{"key":"cardNumber","value":"9999000000000001","description":"Member's card number."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"plans\": []\n}"},{"id":"90ed7462-2f06-4ecc-a16f-30bf4f0b19c0","name":"Not found","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"GET","header":[{"key":"accept","value":"*/*"},{"key":"Accept-Language","value":"","type":"text"},{"key":"Authorization","value":"","type":"text"}],"url":{"raw":"{{base}}/api/Member/GetBenefitsByCardNumber/:cardNumber","host":["{{base}}"],"path":["api","Member","GetBenefitsByCardNumber",":cardNumber"],"variable":[{"key":"cardNumber","value":"9999000000000001","description":"Member's card number."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"InternalServerError\",\n \"Message\": \"Data not found.\"\n }\n ]\n}"}],"_postman_id":"5c6144a4-0cee-4ca6-81ac-8b2ba3543426"},{"name":"List Member by Corporate Code","id":"4ae2be30-5937-4843-b8e4-5c58e2adea1c","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": [\"CORP01\", \"CORP02\"],\n \"page\": { \"page\": 1, \"pageSize\": 10 }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/ListByCorporateCode","description":"

List members across one or many corporate codes.

POST {{base}}/api/Member/ListByCorporateCode

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Envelope	Family D - `{\"isSuccess\", \"message\", \"data\", \"page\"}`

Description

Corporate-scoped member listing. Unlike ListMemberByClientCode, this accepts several corporate codes in one call and processes them in parallel, returning the results grouped by code.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Default	Description
`corporateCode`	string or string[]	No	-	One corporate code, or several. Both forms are accepted - `\"CORP01\"` and `[\"CORP01\",\"CORP02\"]` both work.
`page`	object	No	-	Paging.
`page.page`	integer	No	`1`	Page number.
`page.pageSize`	integer	No	`10`	Page size.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Members, grouped by corporate code.
`400`	Malformed body.
`401`	Missing or expired token.

Response fields

Fields on this family are omitted when null, not sent as null. Which keys appear depends on whether you asked for one code or several - test for key presence.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Present	Description
`isSuccess`	boolean	Always	Whether the call succeeded.
`message`	string	Always	Summary message.
`data.corporateCode`	string	Single code only	The code queried.
`data.members`	array	Single code only	The page of members.
`data.corporateCodeGroups`	array	Always	Per-code groups, each `{ corporateCode, corporateName, claims, pagination }`.
`data.errors`	array	Only on partial failure	`[{ corporateCode, error }]` - one entry per code that failed.
`page`	object	Single code only	`{ totalItems, totalPages, currentPage, pageSize }`.

A partial failure still returns 200. If one corporate code fails and others succeed, you get isSuccess: true with that code listed in data.errors. Always inspect errors.

data.members[] - id (UUID), nik, memberName, clientMemberId, cardNumber, insurerName, policyNumber, age, memberStatus, status, joinDate, dob, planName, productName, corporateName, clientCode, corporateCode, divisionName, effectiveDate. All strings; productName and effectiveDate are nullable.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"523f522d-2941-42db-a086-102b1051e12d","id":"523f522d-2941-42db-a086-102b1051e12d","name":"V1 & V2","type":"folder"}},"urlObject":{"path":["{{apiVersion}}","api","Member","ListByCorporateCode"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"1e13730a-5e81-4c0e-b353-e5e239547e23","name":"Grouped by corporate code","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": [\"CORP01\", \"CORP02\"],\n \"page\": { \"page\": 1, \"pageSize\": 10 }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/ListByCorporateCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"message\": \"SUCCESS\",\n \"data\": {\n \"corporateCodeGroups\": [\n {\n \"corporateCode\": \"CORP01\",\n \"corporateName\": \"Sample Corporate\",\n \"members\": [],\n \"pagination\": {\n \"totalItems\": 0,\n \"totalPages\": 0,\n \"currentPage\": 1,\n \"pageSize\": 10\n }\n }\n ]\n }\n}"},{"id":"0fbf192c-a1cf-41d5-9afe-1f7c567423ab","name":"Partial failure - note HTTP 200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"corporateCode\": [\"CORP01\", \"CORP02\"],\n \"page\": { \"page\": 1, \"pageSize\": 10 }\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/ListByCorporateCode"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"message\": \"One or more corporate codes could not be read.\",\n \"data\": {\n \"corporateCodeGroups\": [],\n \"errors\": [\n { \"corporateCode\": \"CORP02\", \"error\": \"Corporate code not found.\" }\n ]\n }\n}"}],"_postman_id":"4ae2be30-5937-4843-b8e4-5c58e2adea1c"}],"id":"34e5f14c-b966-4f29-94d7-e90e5bd3be1e","description":"

Look up members and their benefits.

No data envelope - these return {\"member\": …} or a paged list at the top level.

\n","_postman_id":"34e5f14c-b966-4f29-94d7-e90e5bd3be1e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"523f522d-2941-42db-a086-102b1051e12d","id":"523f522d-2941-42db-a086-102b1051e12d","name":"V1 & V2","type":"folder"}}},{"name":"Provider","item":[{"name":"List Provider","id":"075e694e-f92b-45ed-a2c9-b45da194d0c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"email\": \"\",\n \"page\": { \"page\": 1, \"pageSize\": 10, \"query\": \"\" },\n \"latitude\": -6.2,\n \"longitude\": 106.8,\n \"distance\": \">= 50\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/{{apiVersion}}/api/Member/ListProviderFacility","description":"

List the provider facilities a member can use, optionally filtered by distance.

POST {{base}}/api/Member/ListProviderFacility

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth	`Authorization: Bearer`
Versions	v1 and v2
Content-Type	`application/json`
Envelope	Family B - `{\"isSuccess\": …, \"data\": …}`

Description

Returns the panel available to a member's plan. Distance filtering was added in 2.5.3 (Jan 2025): supply a coordinate and a distance expression and the list is narrowed to facilities within range.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Default	Description
`cardNumber`	string	Yes	-	Member's card number.
`email`	string	No	-	Caller's email, recorded downstream.
`page`	object	No	-	Paging.
`page.page`	integer	No	`1`	Page number.
`page.pageSize`	integer	No	`10`	Page size.
`page.query`	string	No	`null`	Free-text search across facility names.
`latitude`	number	No	`0`	Must be between -90 and 90.
`longitude`	number	No	`0`	Must be between -180 and 180.
`distance`	string	No	`\"\"`	Distance filter. Format is `<operator> <value>` with a single space, where the operator is `>=` or `<=` - for example `>= 50`. Any other format is rejected.

Distance filtering only makes sense with a coordinate; sending distance while leaving latitude/longitude at 0 filters against the equator.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	The page of facilities.
`400`	Latitude, longitude or distance failed validation - RFC 7807 with `traceId`.
`401`	Missing or expired token.

Response fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`isSuccess`	boolean	No	Whether the downstream call succeeded.
`data.page`	integer	No	Current page.
`data.pageSize`	integer	No	Page size.
`data.totalItems`	integer	No	Total matching facilities.
`data.totalPages`	integer	No	Total pages.
`data.listProviderFacility`	array	No	The facilities. Empty array when none match.

","urlObject":{"path":["{{apiVersion}}","api","Member","ListProviderFacility"],"host":["{{base}}"],"query":[],"variable":[]}},"response":[{"id":"901b30dd-70ee-4580-abed-11538cdd5a24","name":"Page of facilities","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"email\": \"\",\n \"page\": { \"page\": 1, \"pageSize\": 10, \"query\": \"\" },\n \"latitude\": -6.2,\n \"longitude\": 106.8,\n \"distance\": \">= 50\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/ListProviderFacility"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"isSuccess\": true,\n \"data\": {\n \"page\": 1,\n \"pageSize\": 10,\n \"totalItems\": 1,\n \"totalPages\": 1,\n \"listProviderFacility\": [\n {\n \"providerCode\": \"PRV001\",\n \"providerName\": \"Sample Clinic\",\n \"address\": \"1 Sample Street, Jakarta\",\n \"distance\": 4.2\n }\n ]\n }\n}"},{"id":"533cfad7-80e4-46a2-b67c-1b267d6eb709","name":"Invalid distance format","originalRequest":{"auth":{"type":"bearer","bearer":{"token":"{{token}}"}},"method":"POST","header":[{"key":"accept","value":"*/*"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"9999000000000001\",\n \"email\": \"\",\n \"page\": { \"page\": 1, \"pageSize\": 10, \"query\": \"\" },\n \"latitude\": -6.2,\n \"longitude\": 106.8,\n \"distance\": \">= 50\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base}}/api/Member/ListProviderFacility"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"errors\": {\n \"distance\": [\n \"Invalid distance format. Use '[operator] [value]' (e.g., '>= 50').\"\n ]\n },\n \"traceId\": \"00-00000000000000000000000000000000-0000000000000000-00\"\n}"}],"_postman_id":"075e694e-f92b-45ed-a2c9-b45da194d0c3"}],"id":"ee7ae3de-8d8c-413b-8abe-b8a5356e8c22","description":"

List the provider facilities available to a member.

Supports filtering by distance from a coordinate.

\n","_postman_id":"ee7ae3de-8d8c-413b-8abe-b8a5356e8c22","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"523f522d-2941-42db-a086-102b1051e12d","id":"523f522d-2941-42db-a086-102b1051e12d","name":"V1 & V2","type":"folder"}}}],"id":"523f522d-2941-42db-a086-102b1051e12d","description":"

Cambridge OpenAPI V1 & V2 - Enrolment, Claims, Members, Providers

The original Cambridge integration surface. V1 and V2 are single-tenant proxies in front of NOVA: a partner authenticates with a client key and server key, receives a bearer token, and every subsequent call is forwarded to NOVA and enriched on the way.

For new integrations, prefer V3 - it is a first-party multi-tenant system with per-permission authorisation and consistent response shapes. V1 and V2 remain supported for existing partners.

1. Versions

Versioning is by URL segment:

{{base}}/{{apiVersion}}/api/<controller>/<action>\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Variable	Value
`base` - production	`https://id-cambridge.healthmetrics.com`
`base` - staging	`https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app`
`apiVersion`	`v1` or `v2`

base is the bare host, exactly as in V3. Set apiVersion to v2 to call V2 - one variable switches every request in this folder.

The version segment is mandatory. <host>/api/Auth/Login with no version returns 404, verified against staging on 2026-09-23.

Every action in this folder is served on both versions - the application declares ApiVersion 1.0 and 2.0 on all three controllers and maps a separate handler to each.

What actually differs between V1 and V2

The request and response contracts are the same. The difference is downstream: the two versions pass a different version flag to NOVA, so NOVA may resolve a different client configuration. Unless your integration was set up against V1 specifically, use V2.

Requesting a different version

Change base. There is no header or query parameter for version selection, and there is no unversioned route - {{base}} without a version segment returns 404.

2. Authorisation

Two credentials, issued per integration:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Credential	Used for
`clientKey`	Identifies the integration. Sent in the Login body.
`serverKey`	Authenticates the integration. Sent in the Login body.

POST {{base}}/api/Auth/Login exchanges them for a bearer token. Every other endpoint requires:

Authorization: Bearer \n

The token embeds the NOVA client identity resolved at login, so it is scoped to your client's book. It expires - read expiry from the Login response and re-authenticate before then. There is no refresh endpoint.

Credentials are never stored in this collection. clientkey, serverkey, token and BearerToken are secret-typed environment variables with no saved value. Supply them in your own environment.

3. Response conventions - read this first

V1 and V2 do not use one response shape. There are four. Which one you get depends on the endpoint, and nothing in the URL tells you which. This is the single most common source of integration bugs on this API - check the table below before writing a deserialiser.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Family	Shape	Endpoints
A	`{\"data\": …}`	`Auth/Login`, `Member/Enroll`, `Enroll-Member`, `Enroll-Change-Plan`, `Enroll-Update-Effective`, `Enroll-Renewal`, `Suspend`, `Reinstate`, `Terminate`, `ReActivate`, `Enroll/{…}`
B	`{\"isSuccess\": …, \"data\": …}`	`Claims/SubmitClaim`, `Claims/Upload/{claimNumber}`, `Claims/HistoryClaim`, `Member/ListMemberByClientCode`, `Member/ListProviderFacility`
C	resource root, no envelope	`Member/FindByCardNumber`, `Member/GetBenefitsByCardNumber`, `Member/GetListClaim`, `Member/GetDataClaim`
D	`{\"isSuccess\", \"message\", \"data\", \"page\"}`	`Member/ListByCorporateCode`, `Claims/ListByCorporateCode`

(a) Family A - `data` only

{ \"data\": { } }\n

data is an object for Login and an array of member records for every enrolment action. There is no isSuccess on this family - the HTTP status code carries that meaning.

(b) Family B - `isSuccess` plus `data`

{ \"isSuccess\": true, \"data\": { } }\n

isSuccess is the authority here, not the status code. These endpoints can return 200 with isSuccess: false - Claims/Upload and Claims/HistoryClaim both do.

(c) Family C - no envelope at all

The downstream payload arrives at the top level under a resource-specific root key:

{ \"member\": { }, \"familyMember\": [], \"resource\": { } }\n

{ \"plans\": [] }\n

{ \"listGL\": [], \"page\": 1, \"pageSize\": 10, \"totalItems\": 0, \"totalPages\": 0 }\n

{ \"claims\": { } }\n

Do not look for data on these. Each endpoint's own documentation names its root key.

(d) Family D - `isSuccess`, `message`, `data`, `page`

The two ListByCorporateCode endpoints. Unlike every other family, fields here are omitted when null rather than sent as null - page, errors, corporateCode and others disappear from the body entirely depending on whether you asked for one corporate code or several. Test for key presence, not for null.

Success status codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Returned by
`200`	Login, ReActivate, and every query endpoint
`201`	`Enroll` - a member and policy were created
`202`	`Enroll-Member`, `Enroll-Change-Plan`, `Enroll-Update-Effective`, `Enroll-Renewal`, `Terminate`, `Suspend`, `Reinstate` - accepted and applied downstream

Treat 2xx as success rather than matching on 200.

4. Error shapes

Three distinct error bodies. An integration should handle all three.

(a) Business rule refusal - PascalCase, from the exception middleware:

{\n  \"Status\": 400,\n  \"Errors\": [\n    { \"ErrorCode\": \"MemberAndPolicyExist\", \"Message\": \"Policy for this member already exist. To update the plan, please use PUT method instead.\" }\n  ]\n}\n

Status and Errors[].ErrorCode are always present; Errors[].Message is optional. Common codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ErrorCode	Meaning
`MemberAndPolicyExist`	The member already holds this policy. Use the PUT endpoint to change the plan.
`MemberOrPolicyNotExist`	No such member/policy combination.
`InternalServerError`	Also used for \"Data not found.\" on member lookups - check the message, not just the code.

(b) Model-binding validation - RFC 7807, rejected before the handler runs. Note the traceId, which is useful when raising a ticket:

{\n  \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\n  \"title\": \"One or more validation errors occurred.\",\n  \"status\": 400,\n  \"errors\": { \"cardNumber\": [\"The cardNumber field is required.\"] },\n  \"traceId\": \"00-3b86a6c4b27dc9b8359723e347dfe8d0-0fb48761a454a525-00\"\n}\n

(c) Missing or invalid token - 401 with an empty body.

\n\n

Auth/Login returns failures as HTTP 200. A bad client key or server key does not produce a 4xx; it produces:

{ \"data\": \"Not Found\" }\n

Check whether data is a string rather than an object before trusting a Login response. This behaviour is specific to Login.

5. Endpoint inventory

Auth

\n\n\n\n\n\n\n\n\n\n\n\n\n

Method	Path
POST	`/api/Auth/Login`

Enrolment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method	Path	Purpose
POST	`/api/Member/Enroll`	Create member + policy
PUT	`/api/Member/Enroll-Member`	Update member, add dependant
PUT	`/api/Member/Enroll-Change-Plan`	Change plan
PUT	`/api/Member/Enroll-Update-Effective`	Change policy effective dates
PUT	`/api/Member/Enroll-Renewal`	Renew policy
POST	`/api/Member/Suspend`	Suspend a policy
POST	`/api/Member/Reinstate`	Reverse a suspension
POST	`/api/Member/Terminate`	Terminate a policy
POST	`/api/Member/ReActivate`	Re-enrol a terminated member
GET	`/api/Member/Enroll/{memberId}/{policyNumber}/{corporateCode}`	Read an enrolment
POST	`/api/Member/Enroll-Member-Bulk`	Bulk enrol - NOVA-style record
POST	`/api/Member/New-Enroll-Member-Bulk`	Bulk enrol - product-based record

Members

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method	Path
POST	`/api/Member/ListMemberByClientCode`
GET	`/api/Member/FindByCardNumber/{cardNo}`
GET	`/api/Member/GetBenefitsByCardNumber/{cardNo}`
POST	`/api/Member/ListByCorporateCode`

Claims

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method	Path
POST	`/api/Member/GetListClaim`
POST	`/api/Member/GetDataClaim`
POST	`/api/Member/DownloadIGL`
POST	`/api/Member/DownloadFGL`
GET	`/api/Claims/ValidationCashless`
POST	`/api/Claims/SubmitClaimCashless`
POST	`/api/Claims/SubmitClaim`
POST	`/api/Claims/Upload/{claimNumber}`
POST	`/api/Claims/HistoryClaim`
POST	`/api/Claims/GetListDataByClaimNumber`
POST	`/api/Claims/ListByCorporateCode`
GET	`/api/Claims/PolicyDetails`

Providers

\n\n\n\n\n\n\n\n\n\n\n\n\n

Method	Path
POST	`/api/Member/ListProviderFacility`

Not documented here, deliberately: Member/All/{page} is an unscoped listing intended for internal use, and Member/Enroll-Member-Alianz is a client-specific bulk variant. Claims/GetDataByClaimNumber is a GET duplicate of Member/GetDataClaim - use the documented POST.

6. Dates, numbers and paging

Enrolment request dates (dateOfBirth, startDate, endDate) are yyyy-MM-dd.
Bulk enrolment dates are strings with no enforced format - follow the template you were given.
Claim dates in responses are ISO-8601 datetimes.
Money is a JSON number. Currency is named in a sibling field where relevant.
Paged query endpoints take page as an object: { \"page\": 1, \"pageSize\": 10, \"query\": null }, defaults 1 / 10.
The ListByCorporateCode endpoints take paging as { \"page\": 1, \"pageSize\": 10 } and accept corporateCode as either a single string or an array of strings.

7. Example data

Every example in this folder is synthetic and follows one fictional journey:

\n
John Doe, member MEM00000001, policy POL0000000000001, corporate CORP01, card 9999000000000001, claim CL2601010000001H.
\n

No card number, claim number, member name, policy number or key in any example is real.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"_postman_id":"523f522d-2941-42db-a086-102b1051e12d"},{"name":"V3","item":[{"name":"Cambridge API - V3","item":[{"name":"OAuth","item":[{"name":"Get Token","event":[{"listen":"test","script":{"type":"text/javascript","exec":["// Store the access token for every other request in this folder.","if (pm.response.code === 200) {"," const res = pm.response.json();"," pm.collectionVariables.set(\"accessToken\", res.access_token);","}"]}}],"id":"8a40a088-70ca-4fd3-8460-06de5954a317","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"{{clientId}}\",\n \"client_secret\": \"{{clientSecret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/oauth/token","description":"

Obtain a machine access token via the client-credentials grant.

POST /v3/api/oauth/token

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth scheme	None - this is the only unauthenticated endpoint
Permission	-
Content-Type	`application/json`

Description

The only way a machine integration authenticates. The token's permissions and bindings claims are resolved at issue time from the API client's grants and the tenant's data bindings, so a permission or binding change takes effect on the next token, not the current one.

Token lifetime is 60 minutes. There is no refresh mechanism - request a new token.

This request's post-response script writes access_token into the accessToken collection variable, which every other request in this folder inherits.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Description
`grant_type`	string	Yes	Must be `client_credentials` (case-insensitive).
`client_id`	string	Yes	The API client's identifier.
`client_secret`	string	Yes	The API client's secret, as issued at creation or rotation.

Credentials are not stored in this collection. {{clientId}} and {{clientSecret}} are secret-typed environment variables with no saved value.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Token issued.
`400`	Unsupported grant type, or client authentication failed.

Response fields - `200`

All three fields are always present.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`access_token`	string(jwt)	No	Signed JWT, audience `cambridge-api`.
`token_type`	string	No	Always `Bearer`.
`expires_in`	integer(int32)	No	Seconds until expiry - `3600`.

Response fields - `400`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`error`	string	No	`invalid_client` or `unsupported_grant_type`.
`error_description`	string	No	Human-readable cause.

\n
Unknown client ID, wrong secret, disabled client and expired client all collapse into one invalid_client response on purpose - a caller cannot use the error to learn whether a client ID exists.
\n

\n","urlObject":{"path":["v3","api","oauth","token"],"host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"query":[],"variable":[]}},"response":[{"id":"214fae99-4bad-402b-8901-18633c69897e","name":"Token issued","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"{{clientId}}\",\n \"client_secret\": \"{{clientSecret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/oauth/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIs...\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 3600\n}"},{"id":"af5838ae-c4ed-460c-8d62-ffdd77651625","name":"Invalid client","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"{{clientId}}\",\n \"client_secret\": \"{{clientSecret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/oauth/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_client\",\n \"error_description\": \"Client authentication failed.\"\n}"},{"id":"6a3fdd68-1810-481e-813d-7b819213a556","name":"Unsupported grant type","originalRequest":{"auth":{"type":"noauth"},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"{{clientId}}\",\n \"client_secret\": \"{{clientSecret}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/oauth/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"unsupported_grant_type\",\n \"error_description\": \"Only client_credentials grant type is supported.\"\n}"}],"_postman_id":"8a40a088-70ca-4fd3-8460-06de5954a317"}],"id":"ad1f3fa8-f8e0-4314-b2c0-2372323d0bde","description":"

Obtain the machine access token.

Run Get Token first - its post-response script writes the token into the accessToken collection variable, which every other request in this folder inherits.

\n","_postman_id":"ad1f3fa8-f8e0-4314-b2c0-2372323d0bde","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","name":"Cambridge API - V3","type":"folder"}}},{"name":"Claim","item":[{"name":"Search Claim","item":[{"name":"Search Cases","id":"d2886413-1509-44a4-a2da-67dece214b8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/search?page=1&pageSize=10&cardNumber=202601010-00000001","description":"

Search cases and claims within the tenant's scope.

GET /v3/api/cases/search

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth scheme	`cambridge-api` (Bearer)
Permission	`cases:search`
Tenant scoping	Results pre-filtered to corporate + client bindings

Description

Returns a paged, filtered list of cases the calling tenant is permitted to see. Results are already restricted to the tenant's corporate and client bindings, so a caller never needs to filter again on its own side - a case outside those bindings is absent from the page rather than returned with an error.

Parameter names bind case-insensitively, so page and Page both reach the same field.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	In	Type	Format	Req.	Default	Description
`cardNumber`	query	string	-	No	-	Member's card number to filter by.
`status`	query	string	enum	No	-	`New Case`, `Registered`, `FGL Review`, `FGL Released`, `Payment In Progress`, `Paid`, `Void`.
`tipePerawatan`	query	string	enum	No	-	`Rawat inap` (inpatient), `Rawat jalan` (outpatient).
`page`	query	integer	int32, min 1	No	`1`	Page number.
`pageSize`	query	integer	int32, min 1	No	`10`	Page size.
`view`	query	integer	int32	No	-	Alias for `pageSize`. When present it wins.
`Authorization`	header	string	bearer	Yes	-	`Bearer <access_token>` from Get Token.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning	Body
`200`	The page, possibly empty. An out-of-scope or unmatched search is an empty page, not an error.	`V3ListData<CaseDto>`
`400`	Malformed query value, e.g. `page=abc`.	RFC 7807 problem document
`401`	Missing, expired or wrong-audience token.	Empty body + `WWW-Authenticate` header
`403`	Token valid but lacks `cases:search`.	Empty body

Response fields - envelope

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`data.list`	array	No	The page of case summaries. Empty array, never null.
`data.page`	integer(int32)	No	Current page number.
`data.view`	integer(int32)	No	The page size - not a view name.
`data.totalPage`	integer(int32)	No	Total pages available.
`data.totalRecord`	integer(int32)	No	Total matching records across all pages.
`data.query`	string	Yes	Free-text query echo; `null` in current usage.
`data.filter`	object	No	Echoes back the request that produced this page.

Response fields - `data.list[]`

Every one of these 67 fields is nullable. All are always present in the JSON.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	integer(int64)	Internal record ID.
`claimNo`	string	The claim number - pass to Get Case Detail, Validate Billing, Release GL and Void.
`claimNoPayor`	string	Payor's own claim reference.
`idTask`	string	Workflow task ID.
`cardNumber`	string	Member's card number.
`memberName`	string	Member's name.
`memberNumber`, `insuranceNumber`, `polisNumber`	string	Member identifiers.
`dob`	string(date-time)	Date of birth.
`joinDate`, `reinstateDate`	string(date-time)	Membership dates.
`claimStatus`	string	Current status. `Registered` is the only value the Void endpoint accepts.
`prevStatus`, `lastStatus`	string	Previous and last status.
`claimStatusGroup`	string	Coarse grouping, e.g. `Closed`.
`aceStatus`	string	ACE interpretation status; `null` when ACE has not run.
`remark`, `exclussionRemark`	string	Free text. (The double-s spelling is the real field name.)
`plafon`	number(decimal)	Plan ceiling.
`limitAvailable`	number(decimal)	Remaining limit. Never exposed by Price Eligibility, by design.
`paid`, `totalPaid`	number(decimal)	Amount paid.
`totalClaim`	number(decimal)	Amount claimed.
`totalExcess`	number(decimal)	Amount falling to the patient.
`isCoShare`, `isDeductable`, `isFamilySharing`	boolean	Cost-sharing flags.
`coShare`, `deductable`	number(decimal)	Cost-sharing amounts.
`roomPrice`, `occupiedPrice`	number(decimal)	Room rates.
`kursFrom`, `kursTo`, `remarksCurrency`	string	Currency codes.
`rate`, `rateInput`, `bufferRate`	number(decimal)	FX rates.
`exchange`	string	FX rate as a string - inconsistent with the three above.
`diagnoseCode`	string	ICD-10 code.
`diagnoseDesc`	string	Diagnosis description.
`providerCode`, `providerName`	string	Treating provider.
`treatmentType`	string	`Rawat inap` / `Rawat jalan`.
`benefitType`	string	e.g. `OUTPATIENT`, `TELEMEDICINE`.
`claimType`	string	e.g. `CASHLESS`.
`claimSource`	string	e.g. `Web Provider`.
`customerCode`, `customerName`	string	Corporate.
`holdingCode`, `holdingName`	string	Holding group.
`planDetailCode`, `planNameDetail`	string	Plan.
`claimDate`, `admisionDate`, `dischargeDate`	string(date-time)	Claim and treatment dates. (`admisionDate` - the single-d spelling is the real field name.)
`dateBegin`, `dateEnd`	string(date-time)	Policy period.
`datePaid`, `closedAt`, `startPickUp`	string(date-time)	Settlement milestones.
`createdAt`, `updatedAt`	string(date-time)	Audit timestamps.
`onGoingDay`, `onGoingHour`	integer(int32)	Elapsed time in state.
`duration`	string	Human-readable duration, e.g. `1d 2h`.
`analystName`, `avatar`	string	Assigned analyst.

Page number. Default 1.

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Page size. Default 10.

\n","type":"text/plain"},"key":"pageSize","value":"10"},{"description":{"content":"

Member's card number to filter by.

\n","type":"text/plain"},"key":"cardNumber","value":"202601010-00000001"},{"disabled":true,"description":{"content":"

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Rawat inap (inpatient) | Rawat jalan (outpatient)

\n","type":"text/plain"},"key":"tipePerawatan","value":""},{"disabled":true,"description":{"content":"

Alias for pageSize. When present it wins.

\n","type":"text/plain"},"key":"view","value":""}],"variable":[]}},"response":[{"id":"c5527ac5-e859-4993-814f-b95314feec1b","name":"Page of results","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/search?page=1&pageSize=10&cardNumber=202601010-00000001","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","cases","search"],"query":[{"key":"page","value":"1","description":"Page number. Default 1."},{"key":"pageSize","value":"10","description":"Page size. Default 10."},{"key":"cardNumber","value":"202601010-00000001","description":"Member's card number to filter by."},{"key":"status","value":"","description":"New Case | Registered | FGL Review | FGL Released | Payment In Progress | Paid | Void","disabled":true},{"key":"tipePerawatan","value":"","description":"Rawat inap (inpatient) | Rawat jalan (outpatient)","disabled":true},{"key":"view","value":"","description":"Alias for pageSize. When present it wins.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"OK\",\n \"data\": {\n \"list\": [\n {\n \"id\": 10000001,\n \"dob\": \"1990-01-01T00:00:00\",\n \"insuranceNumber\": \"INS00000001\",\n \"polisNumber\": \"POL0000000000001\",\n \"memberNumber\": \"MEM00000001\",\n \"cardNumber\": \"202601010-00000001\",\n \"memberName\": \"John Doe\",\n \"plafon\": 10000000.0,\n \"paid\": 2500000.0,\n \"claimStatus\": \"Paid\",\n \"prevStatus\": \"Payment In Progress\",\n \"claimStatusGroup\": \"Closed\",\n \"limitAvailable\": 7500000.0,\n \"dateBegin\": \"2026-01-01T00:00:00\",\n \"dateEnd\": \"2026-12-31T23:59:59\",\n \"claimNo\": \"CL2601010000001H\",\n \"claimSource\": \"Web Provider\",\n \"customerName\": \"Sample Corporate\",\n \"customerCode\": \"CORP01\",\n \"holdingName\": \"Sample Holding\",\n \"holdingCode\": \"HLD01\",\n \"planDetailCode\": \"PLAN-001\",\n \"planNameDetail\": \"Sample Inpatient Plan (PLAN-001)\",\n \"providerCode\": \"PRV001\",\n \"providerName\": \"Sample Clinic\",\n \"onGoingDay\": 0,\n \"onGoingHour\": 0,\n \"claimDate\": \"2026-01-01T19:52:31\",\n \"admisionDate\": \"2026-01-01T00:00:00\",\n \"dischargeDate\": \"2026-01-01T00:00:00\",\n \"claimType\": \"CASHLESS\",\n \"remark\": \"Paid claim\",\n \"totalPaid\": 2500000.0,\n \"totalExcess\": 0.0,\n \"totalClaim\": 2500000.0,\n \"lastStatus\": \"Paid\",\n \"diagnoseCode\": \"A09\",\n \"diagnoseDesc\": \"Diarrhoea and gastroenteritis of infectious origin\",\n \"exclussionRemark\": \"\",\n \"claimNoPayor\": \"PAY00000001\",\n \"joinDate\": \"2026-01-01T00:00:00\",\n \"reinstateDate\": null,\n \"benefitType\": \"OUTPATIENT\",\n \"kursFrom\": \"IDR\",\n \"kursTo\": \"IDR\",\n \"rate\": 1.0,\n \"exchange\": \"1.0\",\n \"isCoShare\": false,\n \"coShare\": 0.0,\n \"isDeductable\": false,\n \"deductable\": 0.0,\n \"roomPrice\": 500000.0,\n \"occupiedPrice\": 500000.0,\n \"remarksCurrency\": \"IDR\",\n \"rateInput\": 1.0,\n \"bufferRate\": 1.0,\n \"treatmentType\": \"Rawat jalan\",\n \"isFamilySharing\": false,\n \"datePaid\": \"2026-01-15T08:07:58\",\n \"createdAt\": \"2026-01-01T12:52:50\",\n \"updatedAt\": \"2026-01-15T08:07:58\",\n \"startPickUp\": null,\n \"closedAt\": \"2026-01-15T08:07:58\",\n \"analystName\": \"Sample Analyst\",\n \"avatar\": null,\n \"duration\": \"1d 2h\",\n \"idTask\": \"TASK00000001\",\n \"aceStatus\": null\n }\n ],\n \"page\": 1,\n \"view\": 10,\n \"totalPage\": 1,\n \"totalRecord\": 1,\n \"query\": null,\n \"filter\": {\n \"page\": 1,\n \"pageSize\": 10,\n \"view\": null,\n \"cardNumber\": \"202601010-00000001\",\n \"status\": null,\n \"tipePerawatan\": null\n }\n }\n}"},{"id":"932020f0-a549-4f01-9ba8-89258a02f11b","name":"No results","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/search?page=1&pageSize=10&cardNumber=202601010-00000001","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","cases","search"],"query":[{"key":"page","value":"1","description":"Page number. Default 1."},{"key":"pageSize","value":"10","description":"Page size. Default 10."},{"key":"cardNumber","value":"202601010-00000001","description":"Member's card number to filter by."},{"key":"status","value":"","description":"New Case | Registered | FGL Review | FGL Released | Payment In Progress | Paid | Void","disabled":true},{"key":"tipePerawatan","value":"","description":"Rawat inap (inpatient) | Rawat jalan (outpatient)","disabled":true},{"key":"view","value":"","description":"Alias for pageSize. When present it wins.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"OK\",\n \"data\": {\n \"list\": [],\n \"page\": 1,\n \"view\": 10,\n \"totalPage\": 0,\n \"totalRecord\": 0,\n \"query\": null,\n \"filter\": {\n \"page\": 1,\n \"pageSize\": 10,\n \"view\": null,\n \"cardNumber\": \"202601010-00000001\",\n \"status\": null,\n \"tipePerawatan\": null\n }\n }\n}"},{"id":"50233a2e-064b-4d69-8bde-840929ed973e","name":"Unauthenticated - empty body","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/search?page=1&pageSize=10&cardNumber=202601010-00000001","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","cases","search"],"query":[{"key":"page","value":"1","description":"Page number. Default 1."},{"key":"pageSize","value":"10","description":"Page size. Default 10."},{"key":"cardNumber","value":"202601010-00000001","description":"Member's card number to filter by."},{"key":"status","value":"","description":"New Case | Registered | FGL Review | FGL Released | Payment In Progress | Paid | Void","disabled":true},{"key":"tipePerawatan","value":"","description":"Rawat inap (inpatient) | Rawat jalan (outpatient)","disabled":true},{"key":"view","value":"","description":"Alias for pageSize. When present it wins.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"470bb639-4adf-4998-9153-12cc4e8b607a","name":"Missing permission - empty body","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/search?page=1&pageSize=10&cardNumber=202601010-00000001","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","cases","search"],"query":[{"key":"page","value":"1","description":"Page number. Default 1."},{"key":"pageSize","value":"10","description":"Page size. Default 10."},{"key":"cardNumber","value":"202601010-00000001","description":"Member's card number to filter by."},{"key":"status","value":"","description":"New Case | Registered | FGL Review | FGL Released | Payment In Progress | Paid | Void","disabled":true},{"key":"tipePerawatan","value":"","description":"Rawat inap (inpatient) | Rawat jalan (outpatient)","disabled":true},{"key":"view","value":"","description":"Alias for pageSize. When present it wins.","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d2886413-1509-44a4-a2da-67dece214b8d"},{"name":"Get Case Detail","id":"a933e7e5-d245-4104-a0c2-389e2f807b26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/:claimNumber","description":"

Retrieve one case in full, including documents and status log.

GET /v3/api/cases/{claimNumber}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth scheme	`cambridge-api` (Bearer)
Permission	`cases:read`
Tenant scoping	Provider + corporate/client bindings

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	In	Type	Req.	Description
`claimNumber`	path	string	Yes	The claim/case number, e.g. `CL2601010000001H`.
`Authorization`	header	string	Yes	`Bearer <access_token>`.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	The case.
`403`	The claim falls outside the tenant's provider/corporate/client bindings.
`404`	No such claim number.

Response fields - `data`

All fields are nullable and always present.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`claimNumber`, `cardNumber`, `providerCode`	string	Identifiers.
`claimStatus`	string	Current status.
`claimStatusDisplay`	string	Display form, e.g. `Open`, `Closed`.
`claimStatusPrev`, `claimStatusPrevOriginal`	string	Previous status, two variants.
`isConfirmRelease`	boolean	Whether release has been confirmed.
`remark`	string	Free-text remark.
`remarkRejectVoid`	string	The reason supplied when the case was voided.
`claimArea`, `benefitType`, `claimType`, `claimSource`, `treatmentType`	string	Classification.
`indate`, `outdate`	string(date-time)	Admission / discharge. `outdate` is set automatically on void.
`claimDate`, `paymentDate`, `createdDate`, `updatedDate`	string(date-time)	Milestones.
`invoiceNumber`	string	Invoice reference.
`deliveryNotes`	string	Delivery notes.
`members`	string[]	Member names on the case. Initialised to `[]` but typed nullable.
`counter`	integer(int32)	Visit counter.
`aceStatus`	string	ACE status.
`claimDocuments`	object[]	Document groups. Initialised to `[]` but typed nullable.
`logs`	object[]	Status trail. Initialised to `[]` but typed nullable.

claimDocuments[] - label string, area string, document object[]. All nullable.

claimDocuments[].document[] - id integer(int64), name string, status string, isArchive boolean, isActive boolean, receiveDate string(date-time). All nullable.

logs[] - action string, remark string, createdAt string(date-time), createdBy string. All nullable.

The claim/case number, e.g. CL2601010000001H.

\n","type":"text/plain"},"type":"any","value":"CL2601010000001H","key":"claimNumber"}]}},"response":[{"id":"dcfaf5a9-ede5-41cb-9272-80e81e9163f9","name":"Case detail","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/:claimNumber","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","cases",":claimNumber"],"variable":[{"key":"claimNumber","value":"CL2601010000001H","description":"The claim/case number, e.g. CL2601010000001H."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"OK\",\n \"data\": {\n \"treatmentType\": \"Rawat jalan\",\n \"providerCode\": \"PRV001\",\n \"claimNumber\": \"CL2601010000001H\",\n \"cardNumber\": \"202601010-00000001\",\n \"isConfirmRelease\": false,\n \"claimStatusDisplay\": \"Closed\",\n \"claimStatus\": \"Void\",\n \"claimStatusPrev\": \"Registered\",\n \"claimStatusPrevOriginal\": \"Registered\",\n \"claimArea\": \"\",\n \"benefitType\": \"TELEMEDICINE\",\n \"remark\": null,\n \"remarkRejectVoid\": \"Pasien membatalkan janji temu sebelum konsultasi.\",\n \"indate\": \"2026-01-01T00:00:00\",\n \"outdate\": \"2026-01-01T10:36:44.004885\",\n \"claimDate\": \"2026-01-01T10:32:03.587625\",\n \"paymentDate\": null,\n \"deliveryNotes\": null,\n \"createdDate\": \"2026-01-01T10:32:03.587\",\n \"updatedDate\": \"2026-01-01T10:36:44.004\",\n \"members\": [\"John Doe\"],\n \"counter\": 1,\n \"claimDocuments\": [\n {\n \"label\": \"Group_batch_0000000000000_sample\",\n \"area\": \"settlement\",\n \"document\": [\n {\n \"id\": 10000001,\n \"name\": \"260101000000_CL2601010000001H_FPG.pdf\",\n \"status\": \"VALID\",\n \"isArchive\": false,\n \"isActive\": true,\n \"receiveDate\": \"2026-01-01T19:20:07.772\"\n }\n ]\n },\n { \"label\": \"Chat\", \"area\": \"Chat\", \"document\": [] }\n ],\n \"logs\": [\n {\n \"action\": \"CREATE\",\n \"remark\": \"CLAIM CREATED\",\n \"createdAt\": \"2026-01-01T10:32:03.587\",\n \"createdBy\": \"provider@example.com\"\n }\n ],\n \"invoiceNumber\": \"INV00000001\",\n \"claimSource\": \"Web Provider\",\n \"claimType\": \"CASHLESS\",\n \"aceStatus\": null\n }\n}"},{"id":"f90c9ab5-c3ec-4c35-b227-a0c9717564af","name":"Access denied","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/:claimNumber","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","cases",":claimNumber"],"variable":[{"key":"claimNumber","value":"CL2601010000001H","description":"The claim/case number, e.g. CL2601010000001H."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Access denied\",\n \"data\": null\n}"},{"id":"859aba51-023b-4452-bdd9-714afdebdb53","name":"Case not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/:claimNumber","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","cases",":claimNumber"],"variable":[{"key":"claimNumber","value":"CL2601010000001H","description":"The claim/case number, e.g. CL2601010000001H."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Case not found\",\n \"data\": null\n}"}],"_postman_id":"a933e7e5-d245-4104-a0c2-389e2f807b26"}],"id":"411265fe-d918-4574-807b-36af655cdbf3","description":"

Read-only views over cases already in the system: a paged, filtered list, and a single case's full detail including documents and status log.

\n","_postman_id":"411265fe-d918-4574-807b-36af655cdbf3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","name":"Cambridge API - V3","type":"folder"}}},{"name":"Member Eligibility","item":[{"name":"Check Member Eligibility","id":"9e098962-e441-4c7a-8362-616f13f134d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"202601010-00000001\",\n \"dob\": \"1990-01-01\",\n \"providerCode\": \"PRV001\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/member-eligibility","description":"

Confirm the member is active and return their benefit structure.

POST /v3/api/cases/member-eligibility

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth scheme	`cambridge-api` (Bearer)
Permission	`cases:read`
Tenant scoping	Provider + member corporate/client bindings
Content-Type	`application/json`

Description

Run this first. It supplies the benefitCode values that Create Case and Price Eligibility require.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Format	Req.	Description
`cardNumber`	string	-	Yes	Member's card number.
`dob`	string	`yyyy-MM-dd`	Yes	Member's date of birth.
`providerCode`	string	-	No	Provider code; resolved from the tenant's bindings when omitted.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Member is active; benefit structure returned.
`400`	Member unknown, inactive or suspended.
`403`	Provider, corporate or client scope boundary crossed.

Response fields - `data`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`memberStatus`	boolean	No	`true` = active.
`isSuspended`, `isAso`, `isIndividual`, `isGroup`	boolean	No	Status flags.
`isVip`	integer(int32)	No	`0` = not VIP. An int, not a bool.
`benefits`	array	No	Never null; empty array at worst.
`memberId`, `memberInsuranceNumber`, `cardNumber`, `nik`, `memberName`	string	Yes	Identity.
`corporateCode`, `corporateName`, `insurerCode`, `insurerName`	string	Yes	Scope.
`status`, `type`, `remark`, `division`	string	Yes	Classification.
`memberType`	string	Yes	e.g. `Conventional`.
`gender`	string	Yes	`M` / `F`.
`maritalStatus`	string	Yes	`S` / `M`.
`productCode`, `policyNo`	string	Yes	Product and policy.
`dateOfBirth`, `policyStart`, `policyEnd`, `joinDate`, `effectiveDate`, `expiryDate`	string	Yes	Strings, not dates. Pass-through from upstream; do not assume they parse.

Response fields - `benefits[]`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`id`, `planId`	integer(int64)	No	Internal IDs.
`annualLimit`	number(decimal)	No	Annual limit.
`isFamilyShared`, `isShowProvider`	boolean	No	Flags.
`subBenefits`	array	No	Never null.
`benefitCode`	string	Yes	The value Create Case and Price Eligibility need.
`benefitName`, `planName`, `planCode`	string	Yes	Naming.
`condition`, `tnc`, `tncOverseas`, `tncCategory`	string	Yes	Terms.
`planStart`, `planEnd`	string	Yes	Strings, not dates.
`sharingCode`, `currency`	string	Yes	Sharing and currency.

Response fields - `benefits[].subBenefits[]`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`id`, `subBenefitId`	integer(int64)	No	Internal IDs.
`isCashless`	boolean	No	Price Eligibility only considers cashless sub-benefits.
`isReimburstement`, `isAsCharge`, `isPrimary`	boolean	No	Flags. (The misspelling is the real field name.)
`annualLimit`	number(decimal)	No	Sub-benefit limit.
`coShare`	number(decimal)	No	`100` means the insurer covers 100%.
`condition`	array	No	Quota rules; never null.
`subBenefitCode`, `category`, `subBenefitName`, `clientsSubBenefit`, `type`, `sharingCode`	string	Yes	Classification.
`preDisability`, `postDisability`, `disabilityByIcd`	string	Yes	Disability terms.
`details`	array	Yes	Normalised to an array or null. Upstream sends null, an array, a single object, or a JSON-encoded string - a converter absorbs all of those.

subBenefits[].condition[] - id integer(int64), amount number(decimal), type string (e.g. Active Polis), conditionType string (e.g. qty). This is the visit-quota rule that Price Eligibility evaluates.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	message	Cause
400	Exclusion/Member Nonactive.	Member unknown, inactive or suspended.
403	Access denied to the specified provider.	`providerCode` outside the tenant's provider bindings.
403	Access denied to the member's corporate scope.	Member's corporate code outside the tenant's bindings.
403	Access denied to the member's client scope.	Member's client code outside the tenant's bindings.

\n
The live API may also return a raw downstream code such as StatusInactive in message for the same 400. Handle on status code, not on message text.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","name":"Cambridge API - V3","type":"folder"}},"urlObject":{"path":["v3","api","cases","member-eligibility"],"host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"query":[],"variable":[]}},"response":[{"id":"777602ed-5251-40c7-b362-c04f345b668d","name":"Member active","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"202601010-00000001\",\n \"dob\": \"1990-01-01\",\n \"providerCode\": \"PRV001\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/member-eligibility"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"OK\",\n \"data\": {\n \"status\": null,\n \"corporateCode\": \"CORP01\",\n \"corporateName\": \"Sample Corporate\",\n \"insurerCode\": \"CLI01\",\n \"insurerName\": \"Sample Insurance\",\n \"memberId\": \"00000000-0000-0000-0000-000000000001\",\n \"memberInsuranceNumber\": \"INS00000001\",\n \"cardNumber\": \"202601010-00000001\",\n \"nik\": \"0000000000000001\",\n \"memberName\": \"John Doe\",\n \"memberStatus\": true,\n \"memberType\": \"Conventional\",\n \"dateOfBirth\": \"1990-01-01\",\n \"gender\": \"M\",\n \"maritalStatus\": \"S\",\n \"isSuspended\": false,\n \"isVip\": 0,\n \"isAso\": false,\n \"isIndividual\": true,\n \"isGroup\": false,\n \"productCode\": \"PRD001\",\n \"policyNo\": \"POL0000000000001\",\n \"policyStart\": \"2026-01-01\",\n \"policyEnd\": \"2026-12-31\",\n \"joinDate\": \"2026-01-01\",\n \"remark\": null,\n \"type\": null,\n \"effectiveDate\": null,\n \"expiryDate\": null,\n \"benefits\": [\n {\n \"id\": 10000001,\n \"benefitCode\": \"00000001\",\n \"benefitName\": \"TELEMEDICINE\",\n \"planName\": \"Sample Telemedicine Plan (TELE-001)\",\n \"planCode\": \"TELE-001\",\n \"planId\": 0,\n \"annualLimit\": 0.0,\n \"condition\": null,\n \"tnc\": null,\n \"tncOverseas\": null,\n \"tncCategory\": null,\n \"planStart\": null,\n \"planEnd\": null,\n \"isFamilyShared\": false,\n \"isShowProvider\": false,\n \"sharingCode\": null,\n \"currency\": \"IDR\",\n \"subBenefits\": [\n {\n \"id\": 10000002,\n \"subBenefitCode\": null,\n \"category\": \"OUTPATIENT\",\n \"subBenefitName\": \"Medicine GP\",\n \"clientsSubBenefit\": null,\n \"isCashless\": true,\n \"isReimburstement\": false,\n \"isAsCharge\": false,\n \"annualLimit\": 0.0,\n \"type\": \"OUTPATIENT\",\n \"coShare\": 100.0,\n \"sharingCode\": null,\n \"isPrimary\": false,\n \"details\": null,\n \"condition\": [\n {\n \"id\": 10000003,\n \"amount\": 3.0,\n \"type\": \"Active Polis\",\n \"conditionType\": \"qty\"\n }\n ],\n \"subBenefitId\": 0,\n \"preDisability\": null,\n \"postDisability\": null,\n \"disabilityByIcd\": null\n }\n ]\n }\n ],\n \"division\": \"\"\n }\n}"},{"id":"baaa524a-bb3f-4a8d-aeac-fde3d989df96","name":"Member inactive","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"202601010-00000001\",\n \"dob\": \"1990-01-01\",\n \"providerCode\": \"PRV001\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/member-eligibility"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Exclusion/Member Nonactive.\",\n \"data\": null\n}"},{"id":"04780dca-4901-47d8-a64a-a1d007398486","name":"Outside corporate scope","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"202601010-00000001\",\n \"dob\": \"1990-01-01\",\n \"providerCode\": \"PRV001\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/member-eligibility"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Access denied to the member's corporate scope.\",\n \"data\": null\n}"}],"_postman_id":"9e098962-e441-4c7a-8362-616f13f134d8"}],"id":"bacf11d7-c916-42bb-8739-9a5d02dcea5f","description":"

Confirms a member is active and returns their benefit structure.

Run this first. It supplies the benefitCode values that Create Case and Price Eligibility require.

\n","_postman_id":"bacf11d7-c916-42bb-8739-9a5d02dcea5f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","name":"Cambridge API - V3","type":"folder"}}},{"name":"Price Eligibility","item":[{"name":"Check Price Eligibility","id":"4c5a7e3b-80b1-4cce-ae31-22976dc71399","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"202601010-00000001\",\n \"dob\": \"1990-01-01\",\n \"benefitCode\": \"00000001\",\n \"amount\": 100000\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/price-eligibility","description":"

Check whether an amount is covered, before a case exists.

POST /v3/api/cases/price-eligibility

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth scheme	`cambridge-api` (Bearer)
Permission	`cases:read`
Tenant scoping	Provider + member corporate/client bindings, plus claim scope in add-on mode
Content-Type	`application/json`

Description

Lets a provider gate a booking without ever learning the member's remaining limits or visit counts. Two moments in the partner flow use it:

Pre-booking check - before any case exists. Confirm coverage for the consultation price before committing to the booking. No claimNumber is available yet.
Prescription add-on check - after the consultation, once the case exists and the FGL is released. Supply the original claimNumber so the consultation's own consumption is excluded - an add-on against the member's final allowed visit must not be refused because the consultation itself already used that visit.

The response is deliberately binary in money terms: either the insurer pays (minus any static plan-rule co-pay such as co-share or a per-visit cap) or the patient pays the whole amount. No response value is ever derived from the member's remaining limit or remaining visit count.

A not-eligible verdict always carries the same one generic message, whatever the underlying reason - limit exhausted, visits exhausted, price above cover, exclusion, or no applicable cashless sub-benefit (the last of these is itself a 200 coverage verdict, not an error). Do not branch integration logic on that wording changing per case; it never will, and no more specific reason is ever returned.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Format	Req.	Description
`cardNumber`	string	-	Yes	Member's card number.
`dob`	string	`yyyy-MM-dd`	Yes	Member's date of birth.
`benefitCode`	string	-	Yes	Benefit code to check, matched against the member's benefits as returned by Member Eligibility.
`amount`	number	decimal	Yes	The price to check. Must be greater than 0 - an explicit guard rejects zero or negative.
`providerCode`	string	-	No	Provider code; resolved from the tenant's bindings when omitted.
`claimNumber`	string	-	No	The original consultation's claim number - only for the prescription add-on check. Omit for the pre-booking check.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	A coverage verdict - including `eligible: false`, which is not an error.
`400`	Empty payload, non-positive amount, inactive member, or unknown benefit code.
`403`	Provider, corporate, client or claim scope boundary crossed.

Response fields - `data`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`eligible`	boolean	No	Whether the amount is covered.
`patientPayAmount`	number(decimal)	No	What the patient pays. Equals the full requested amount when `eligible` is `false`.
`message`	string	Yes	`null` when eligible; the one generic non-coverage string otherwise.

\n
Three fields on the claim service's internal verdict - coveredAmount, reasons[] and resolvedRules - are deliberately dropped before the response leaves Cambridge. Do not expect them.
\n

Failures - `400`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Cause	message
Payload empty or malformed	Request payload cannot be empty.
`amount` zero or negative	Amount must be greater than zero.
Member unknown, inactive or suspended	Exclusion/Member Nonactive.
`benefitCode` not on the member's product	Benefit code '{benefitCode}' was not found for this member.

Failures - `403`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Cause	message
`providerCode` outside the tenant's provider bindings	Access denied to the specified provider.
Member's corporate code outside the tenant's bindings	Access denied to the member's corporate scope.
Member's client code outside the tenant's bindings	Access denied to the member's client scope.
Tenant has no bindings at all but supplied a `claimNumber`	Access denied to the specified claim.
`claimNumber` unknown, or belonging to another tenant	Claim number '{claimNumber}' was not found or access is denied.
`claimNumber`'s provider outside the tenant's provider bindings	Access denied to the claim '{claimNumber}' due to provider scope.
`claimNumber`'s corporate/client code outside the tenant's bindings	Access denied to the claim '{claimNumber}' due to corporate/client scope.

Answers one question: is this amount covered?

Used at two moments in the partner flow - before a booking exists, and again for a prescription add-on after the guarantee letter is released. The response is binary in money terms and never discloses the member's remaining limit or visit count.

\n","_postman_id":"25295163-d53c-420c-acb4-1831cf0d445f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","name":"Cambridge API - V3","type":"folder"}}},{"name":"Claim Outpatient","item":[{"name":"1. Create Case","id":"cc8ab766-367d-4ddd-8e1b-eb079c0c4970","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"202601010-00000001\",\n \"providerCode\": \"PRV001\",\n \"dob\": \"1990-01-01\",\n \"benefitCode\": \"00000001\",\n \"providerName\": \"Sample Clinic\",\n \"providerAddress\": \"1 Sample Street\",\n \"providerCity\": \"Jakarta\",\n \"polyCode\": \"\",\n \"polyName\": \"\",\n \"doctor\": \"\",\n \"phone\": \"+628000000001\",\n \"treatmentType\": \"Rawat jalan\",\n \"indate\": \"2026-01-01\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases","description":"

Create a case and submit a cashless claim.

POST /v3/api/cases

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth scheme	`cambridge-api` (Bearer)
Permission	`cases:write`
Tenant scoping	Provider + member corporate/client bindings
Content-Type	`application/json`

Description

Registers the case and returns its claim number. The new case is in Registered status, which is the only status the Void endpoint accepts.

\n
Note: the downstream Claim Service returns a binary PDF (the registration form / guarantee letter) on success. Cambridge intercepts that response, extracts the generated claim number from the Content-Disposition filename (e.g. Register_Form_CL2601010000001H.pdf) and returns JSON. Partners never see the PDF.
\n

Request body

Field	Type	Format	Req.	Default	Description
`cardNumber`	string	-	Yes	-	Member's card number.
`providerCode`	string	-	Yes	-	Healthcare provider code.
`dob`	string	`yyyy-MM-dd`	Yes	-	Member's date of birth.
`benefitCode`	string	-	Yes	-	Benefit code selected for the treatment, from Member Eligibility.
`providerName`	string	-	No	`\"\"`	Provider name.
`providerAddress`	string	-	No	`\"\"`	Provider address.
`providerCity`	string	-	No	`\"\"`	Provider city.
`polyCode`	string	-	No	`\"\"`	Polyclinic code.
`polyName`	string	-	No	`\"\"`	Polyclinic name.
`doctor`	string	-	No	`\"\"`	Doctor's name.
`phone`	string	-	No	`\"\"`	Provider phone number.
`treatmentType`	string	enum	No	`Rawat jalan`	`Rawat inap` / `Rawat jalan`.
`indate`	string	`yyyy-MM-dd`	No	`\"\"`	Admission date.

\n
Optional fields default to empty strings, not null - omitting them sends \"\" downstream.
\n

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Case created; claim number returned.
`400`	Member suspended or inactive, or benefit validation failed.
`403`	Provider or member scope boundary crossed.

Response fields - `data`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`claimNumber`	string	No	The generated claim number. Defaults to `\"\"`.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Example message	Cause
400	Exclusion/Member Nonactive.	Member suspended, inactive, or benefit validation failed.
403	Access denied to the specified provider.	`providerCode`, or the member's corporate/client codes, fall outside the tenant's bindings.

\n
The live API may also return a raw downstream code such as ActiveClaim in message for the same 400. Handle on status code, not on message text.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","name":"Cambridge API - V3","type":"folder"}},"urlObject":{"path":["v3","api","cases"],"host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"query":[],"variable":[]}},"response":[{"id":"2ec80fd4-d724-44a3-8ab8-702223c82b57","name":"Case created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"202601010-00000001\",\n \"providerCode\": \"PRV001\",\n \"dob\": \"1990-01-01\",\n \"benefitCode\": \"00000001\",\n \"providerName\": \"Sample Clinic\",\n \"providerAddress\": \"1 Sample Street\",\n \"providerCity\": \"Jakarta\",\n \"polyCode\": \"\",\n \"polyName\": \"\",\n \"doctor\": \"\",\n \"phone\": \"+628000000001\",\n \"treatmentType\": \"Rawat jalan\",\n \"indate\": \"2026-01-01\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"OK\",\n \"data\": {\n \"claimNumber\": \"CL2601010000001H\"\n }\n}"},{"id":"17777d4e-855d-4c47-b7a5-9a71c456f941","name":"Member inactive","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"202601010-00000001\",\n \"providerCode\": \"PRV001\",\n \"dob\": \"1990-01-01\",\n \"benefitCode\": \"00000001\",\n \"providerName\": \"Sample Clinic\",\n \"providerAddress\": \"1 Sample Street\",\n \"providerCity\": \"Jakarta\",\n \"polyCode\": \"\",\n \"polyName\": \"\",\n \"doctor\": \"\",\n \"phone\": \"+628000000001\",\n \"treatmentType\": \"Rawat jalan\",\n \"indate\": \"2026-01-01\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Exclusion/Member Nonactive.\",\n \"data\": null\n}"},{"id":"36cd1507-8ea2-4469-8980-6487f6b1d787","name":"Access denied to provider","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cardNumber\": \"202601010-00000001\",\n \"providerCode\": \"PRV001\",\n \"dob\": \"1990-01-01\",\n \"benefitCode\": \"00000001\",\n \"providerName\": \"Sample Clinic\",\n \"providerAddress\": \"1 Sample Street\",\n \"providerCity\": \"Jakarta\",\n \"polyCode\": \"\",\n \"polyName\": \"\",\n \"doctor\": \"\",\n \"phone\": \"+628000000001\",\n \"treatmentType\": \"Rawat jalan\",\n \"indate\": \"2026-01-01\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Access denied to the specified provider.\",\n \"data\": null\n}"}],"_postman_id":"cc8ab766-367d-4ddd-8e1b-eb079c0c4970"},{"name":"2. Validate Outpatient Billing","id":"999e7881-bc41-47b3-bb65-3566f6efd10f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"idBenefit\": 10000001,\n \"claimNumber\": \"CL2601010000001H\",\n \"cardNumber\": \"202601010-00000001\",\n \"claimAmount\": 100000,\n \"exclusionAmount\": 0,\n \"prorate\": false,\n \"qty\": 1,\n \"roomBenefit\": false,\n \"coShare\": 100\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/validate-billing","description":"

Validate the billing lines on a case before releasing the guarantee letter.

POST /v3/api/cases/validate-billing

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth scheme	`cambridge-api` (Bearer)
Permission	`cases:write`
Tenant scoping	Provider + corporate/client bindings, per claim in the list
Content-Type	`application/json`

Description

The request body is an array, one entry per billing line. The response reports batch totals plus a per-line breakdown of what the insurer covers and what falls to the patient as excess.

Request body - array item

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Default	Description
`idBenefit`	integer(int64)	Yes*	-	The benefit ID.
`claimNumber`	string	Yes	-	The claim being billed.
`cardNumber`	string	Yes	-	Member's card number.
`claimAmount`	number(decimal)	Yes*	-	The amount claimed for this line.
`exclusionAmount`	number(decimal)	No	`0`	Excluded amount.
`prorate`	boolean	No	`false`	Prorate the line.
`qty`	integer(int32)	No	`1`	Quantity.
`roomBenefit`	boolean	No	`false`	Treat as a room benefit.
`coShare`	number(decimal)	No	`100`	Co-share percentage.

\n
* Send idBenefit and claimAmount explicitly. They are marked required but sit on non-nullable numeric types, where the framework's required check only rejects null. Omit claimAmount and the line is validated as a zero-amount line rather than rejected with a 400.
\n

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Lines validated; totals and per-line results returned.
`400`	Empty or malformed array.
`403`	A claim in the list falls outside the tenant's bindings.

Response fields - `data`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`isSuccess`	boolean	No	Downstream call succeeded.
`message`	string	No	e.g. `Successfully processed requests`.
`isValidate`	boolean	No	Validation verdict.
`totalClaim`	number(decimal)	No	Total claimed across the batch.
`totalPaid`	number(decimal)	No	Total insurer-covered.
`totalExcess`	number(decimal)	No	Total falling to the patient.
`data`	array	No	Per-line results; empty array, never null.
`data[].idBenefit`	integer(int64)	No	The benefit ID from the request line.
`data[].paid`	number(decimal)	No	Insurer-covered for this line.
`data[].excess`	number(decimal)	No	Patient-paid for this line.
`data[].remark`	string	Yes	Declared non-nullable in the contract, but the live response returns `null`. Treat as nullable.
`data[].sharingCode`	string	Yes	Same mismatch as `remark`.
`data[].isPrimary`	boolean	No	Primary sub-benefit flag.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Example message	Cause
400	Request payload cannot be empty.	Empty or malformed array.
403	Access denied to the claim 'CL2601010000001H' due to provider/corporate/client scope.	A claim in the list falls outside the tenant's bindings.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","name":"Cambridge API - V3","type":"folder"}},"urlObject":{"path":["v3","api","cases","validate-billing"],"host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"query":[],"variable":[]}},"response":[{"id":"c0b4bc82-27ef-4d8b-866f-41cfd732888d","name":"Partially covered","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"idBenefit\": 10000001,\n \"claimNumber\": \"CL2601010000001H\",\n \"cardNumber\": \"202601010-00000001\",\n \"claimAmount\": 100000,\n \"exclusionAmount\": 0,\n \"prorate\": false,\n \"qty\": 1,\n \"roomBenefit\": false,\n \"coShare\": 100\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/validate-billing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"OK\",\n \"data\": {\n \"isSuccess\": true,\n \"message\": \"Successfully processed requests\",\n \"isValidate\": true,\n \"totalClaim\": 10000000,\n \"totalPaid\": 120030.00,\n \"totalExcess\": 9879970.00,\n \"data\": [\n {\n \"idBenefit\": 10000001,\n \"paid\": 120030.00,\n \"excess\": 9879970.00,\n \"remark\": \"Excess of inner limit or condition limit\",\n \"sharingCode\": \"\",\n \"isPrimary\": false\n }\n ]\n }\n}"},{"id":"15103ae0-4d3c-4c14-9da3-07b8b3c0b3fd","name":"Fully excess","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"idBenefit\": 10000001,\n \"claimNumber\": \"CL2601010000001H\",\n \"cardNumber\": \"202601010-00000001\",\n \"claimAmount\": 100000,\n \"exclusionAmount\": 0,\n \"prorate\": false,\n \"qty\": 1,\n \"roomBenefit\": false,\n \"coShare\": 100\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/validate-billing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"OK\",\n \"data\": {\n \"isSuccess\": true,\n \"message\": \"Successfully processed requests\",\n \"isValidate\": true,\n \"totalClaim\": 100000,\n \"totalPaid\": 0,\n \"totalExcess\": 100000,\n \"data\": [\n {\n \"idBenefit\": 10000001,\n \"paid\": 0,\n \"excess\": 100000,\n \"remark\": null,\n \"sharingCode\": null,\n \"isPrimary\": false\n }\n ]\n }\n}"},{"id":"fcd8d98f-9f60-49a2-b88c-46b7ec425e5d","name":"Empty payload","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"idBenefit\": 10000001,\n \"claimNumber\": \"CL2601010000001H\",\n \"cardNumber\": \"202601010-00000001\",\n \"claimAmount\": 100000,\n \"exclusionAmount\": 0,\n \"prorate\": false,\n \"qty\": 1,\n \"roomBenefit\": false,\n \"coShare\": 100\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/validate-billing"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Request payload cannot be empty.\",\n \"data\": null\n}"},{"id":"7c998d78-8e8e-4959-a6f3-1ccf161fb801","name":"Claim outside scope","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"idBenefit\": 10000001,\n \"claimNumber\": \"CL2601010000001H\",\n \"cardNumber\": \"202601010-00000001\",\n \"claimAmount\": 100000,\n \"exclusionAmount\": 0,\n \"prorate\": false,\n \"qty\": 1,\n \"roomBenefit\": false,\n \"coShare\": 100\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/validate-billing"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Access denied to the claim 'CL2601010000001H' due to provider/corporate/client scope.\",\n \"data\": null\n}"}],"_postman_id":"999e7881-bc41-47b3-bb65-3566f6efd10f"},{"name":"3. Release Guarantee Letter","id":"0d3f23fb-cd3d-4a31-a8e5-11b20e0614ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"claimNo\": \"CL2601010000001H\",\n \"icdCode1\": \"A01\",\n \"icdCode2\": \"\",\n \"icdCode3\": \"\",\n \"icdCode4\": \"\",\n \"doctor\": \"Dr. Sample\",\n \"polyCode\": \"POLY01\",\n \"polyName\": \"Sample Poly\",\n \"remark\": \"\",\n \"updatedBy\": \"analyst@example.com\",\n \"benefitDetail\": {\n \"id\": 10000001,\n \"benefitName\": \"TELEMEDICINE\",\n \"planName\": \"Sample Telemedicine Plan (TELE-001)\",\n \"benefitCode\": \"00000001\",\n \"condition\": null,\n \"annualLimit\": 0,\n \"subBenefits\": [\n {\n \"id\": 10000002,\n \"category\": \"OUTPATIENT\",\n \"SubBenefitName\": \"Medicine GP\",\n \"isCashless\": true,\n \"isReimburstement\": false,\n \"type\": \"OUTPATIENT\",\n \"claimValue\": 100000,\n \"excessValue\": 0,\n \"details\": null,\n \"condition\": [\n { \"Id\": 10000003, \"Type\": \"Active Polis\", \"Amount\": 3, \"ConditionType\": \"qty\" }\n ],\n \"coShare\": 100\n }\n ]\n },\n \"emailProvider\": \"provider@example.com\",\n \"treatmentDate\": \"2026-01-01T00:00:00+00:00\",\n \"treatmentPlan\": \"\",\n \"costEstimation\": \"\",\n \"currency\": \"\",\n \"planPolis\": \"Sample Telemedicine Plan (TELE-001)\",\n \"memberName\": \"John Doe\",\n \"diagnose\": \"Sample diagnosis\",\n \"noPolis\": \"POL0000000000001\",\n \"nameProvider\": \"Sample Clinic\",\n \"insuranceName\": \"Sample Insurance\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/outpatient/release-gl","description":"

Process the claim and release the guarantee letter, moving the case to FGL Released.

POST /v3/api/cases/outpatient/release-gl

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth scheme	`cambridge-api` (Bearer)
Permission	`cases:write`
Tenant scoping	Provider + corporate/client bindings
Content-Type	`application/json`

Description

Calls the downstream ProcessClaim/OUTPATIENT and UpdateStatus operations in sequence.

After this succeeds the case can no longer be voided through the API - voiding is then an operations action.

Request body

Field	Type	Format	Req.	Default	Description
`claimNo`	string	-	Yes	-	The claim number.
`icdCode1`	string	-	Yes	-	Primary ICD-10 diagnosis code.
`icdCode2` - `icdCode4`	string	-	No	`null`	Additional diagnosis codes.
`doctor`	string	-	Yes	-	Treating doctor.
`polyCode`	string	-	Yes	-	Polyclinic code.
`polyName`	string	-	Yes	-	Polyclinic name.
`remark`	string	-	No	`\"\"`	Free-text remarks.
`updatedBy`	string	email	Yes	-	Email of the user releasing the letter.
`benefitDetail`	object	-	Yes	-	The benefit structure, including per-sub-benefit `claimValue`. An object, not a string.
`emailProvider`	string	email	Yes	-	Provider email address.
`treatmentDate`	string	date-time	Yes*	-	ISO-8601 treatment date with offset.
`treatmentPlan`	string	-	No	`\"\"`	Treatment plan description.
`costEstimation`	string	-	No	`\"\"`	Cost estimate.
`currency`	string	-	No	`\"\"`	Currency code.
`planPolis`	string	-	Yes	-	Policy plan name.
`memberName`	string	-	Yes	-	Member name.
`diagnose`	string	-	Yes	-	Diagnosis description.
`noPolis`	string	-	Yes	-	Policy number.
`nameProvider`	string	-	Yes	-	Provider name.
`insuranceName`	string	-	Yes	-	Insurer name.

\n
* Send treatmentDate explicitly. Like claimAmount on Validate Billing, it sits on a non-nullable value type - omitting it sends 0001-01-01T00:00:00 downstream rather than returning a 400. benefitDetail is enforced properly, because it is a reference type.
\n

Carry benefitDetail through from Member Eligibility, setting claimValue per sub-benefit.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Guarantee letter released.
`400`	Empty payload, or the downstream release failed.
`403`	The claim falls outside the tenant's bindings.

Response fields - `data`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`isSuccess`	boolean	No	Always `true` on a `200`.
`message`	string	No	Always `SUCCESS`.
`claimNumber`	string	No	The claim acted on.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Example message	Cause
400	Request payload cannot be empty.	Empty payload, or the downstream release failed.
403	Access denied to the claim 'CL2601010000001H' due to provider/corporate/client scope.	The claim falls outside the tenant's bindings.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","name":"Cambridge API - V3","type":"folder"}},"urlObject":{"path":["v3","api","cases","outpatient","release-gl"],"host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"query":[],"variable":[]}},"response":[{"id":"42f0337c-d32a-4eab-bc46-4932e176d8a3","name":"Guarantee letter released","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"claimNo\": \"CL2601010000001H\",\n \"icdCode1\": \"A01\",\n \"icdCode2\": \"\",\n \"icdCode3\": \"\",\n \"icdCode4\": \"\",\n \"doctor\": \"Dr. Sample\",\n \"polyCode\": \"POLY01\",\n \"polyName\": \"Sample Poly\",\n \"remark\": \"\",\n \"updatedBy\": \"analyst@example.com\",\n \"benefitDetail\": {\n \"id\": 10000001,\n \"benefitName\": \"TELEMEDICINE\",\n \"planName\": \"Sample Telemedicine Plan (TELE-001)\",\n \"benefitCode\": \"00000001\",\n \"condition\": null,\n \"annualLimit\": 0,\n \"subBenefits\": [\n {\n \"id\": 10000002,\n \"category\": \"OUTPATIENT\",\n \"SubBenefitName\": \"Medicine GP\",\n \"isCashless\": true,\n \"isReimburstement\": false,\n \"type\": \"OUTPATIENT\",\n \"claimValue\": 100000,\n \"excessValue\": 0,\n \"details\": null,\n \"condition\": [\n { \"Id\": 10000003, \"Type\": \"Active Polis\", \"Amount\": 3, \"ConditionType\": \"qty\" }\n ],\n \"coShare\": 100\n }\n ]\n },\n \"emailProvider\": \"provider@example.com\",\n \"treatmentDate\": \"2026-01-01T00:00:00+00:00\",\n \"treatmentPlan\": \"\",\n \"costEstimation\": \"\",\n \"currency\": \"\",\n \"planPolis\": \"Sample Telemedicine Plan (TELE-001)\",\n \"memberName\": \"John Doe\",\n \"diagnose\": \"Sample diagnosis\",\n \"noPolis\": \"POL0000000000001\",\n \"nameProvider\": \"Sample Clinic\",\n \"insuranceName\": \"Sample Insurance\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/outpatient/release-gl"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"OK\",\n \"data\": {\n \"isSuccess\": true,\n \"message\": \"SUCCESS\",\n \"claimNumber\": \"CL2601010000001H\"\n }\n}"},{"id":"ac388b64-8dab-4b11-bae1-bbc26696c473","name":"Empty payload","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"claimNo\": \"CL2601010000001H\",\n \"icdCode1\": \"A01\",\n \"icdCode2\": \"\",\n \"icdCode3\": \"\",\n \"icdCode4\": \"\",\n \"doctor\": \"Dr. Sample\",\n \"polyCode\": \"POLY01\",\n \"polyName\": \"Sample Poly\",\n \"remark\": \"\",\n \"updatedBy\": \"analyst@example.com\",\n \"benefitDetail\": {\n \"id\": 10000001,\n \"benefitName\": \"TELEMEDICINE\",\n \"planName\": \"Sample Telemedicine Plan (TELE-001)\",\n \"benefitCode\": \"00000001\",\n \"condition\": null,\n \"annualLimit\": 0,\n \"subBenefits\": [\n {\n \"id\": 10000002,\n \"category\": \"OUTPATIENT\",\n \"SubBenefitName\": \"Medicine GP\",\n \"isCashless\": true,\n \"isReimburstement\": false,\n \"type\": \"OUTPATIENT\",\n \"claimValue\": 100000,\n \"excessValue\": 0,\n \"details\": null,\n \"condition\": [\n { \"Id\": 10000003, \"Type\": \"Active Polis\", \"Amount\": 3, \"ConditionType\": \"qty\" }\n ],\n \"coShare\": 100\n }\n ]\n },\n \"emailProvider\": \"provider@example.com\",\n \"treatmentDate\": \"2026-01-01T00:00:00+00:00\",\n \"treatmentPlan\": \"\",\n \"costEstimation\": \"\",\n \"currency\": \"\",\n \"planPolis\": \"Sample Telemedicine Plan (TELE-001)\",\n \"memberName\": \"John Doe\",\n \"diagnose\": \"Sample diagnosis\",\n \"noPolis\": \"POL0000000000001\",\n \"nameProvider\": \"Sample Clinic\",\n \"insuranceName\": \"Sample Insurance\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/outpatient/release-gl"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Request payload cannot be empty.\",\n \"data\": null\n}"},{"id":"0f7cc1e9-90da-4017-b0cf-ab68549ae95f","name":"Claim outside scope","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"claimNo\": \"CL2601010000001H\",\n \"icdCode1\": \"A01\",\n \"icdCode2\": \"\",\n \"icdCode3\": \"\",\n \"icdCode4\": \"\",\n \"doctor\": \"Dr. Sample\",\n \"polyCode\": \"POLY01\",\n \"polyName\": \"Sample Poly\",\n \"remark\": \"\",\n \"updatedBy\": \"analyst@example.com\",\n \"benefitDetail\": {\n \"id\": 10000001,\n \"benefitName\": \"TELEMEDICINE\",\n \"planName\": \"Sample Telemedicine Plan (TELE-001)\",\n \"benefitCode\": \"00000001\",\n \"condition\": null,\n \"annualLimit\": 0,\n \"subBenefits\": [\n {\n \"id\": 10000002,\n \"category\": \"OUTPATIENT\",\n \"SubBenefitName\": \"Medicine GP\",\n \"isCashless\": true,\n \"isReimburstement\": false,\n \"type\": \"OUTPATIENT\",\n \"claimValue\": 100000,\n \"excessValue\": 0,\n \"details\": null,\n \"condition\": [\n { \"Id\": 10000003, \"Type\": \"Active Polis\", \"Amount\": 3, \"ConditionType\": \"qty\" }\n ],\n \"coShare\": 100\n }\n ]\n },\n \"emailProvider\": \"provider@example.com\",\n \"treatmentDate\": \"2026-01-01T00:00:00+00:00\",\n \"treatmentPlan\": \"\",\n \"costEstimation\": \"\",\n \"currency\": \"\",\n \"planPolis\": \"Sample Telemedicine Plan (TELE-001)\",\n \"memberName\": \"John Doe\",\n \"diagnose\": \"Sample diagnosis\",\n \"noPolis\": \"POL0000000000001\",\n \"nameProvider\": \"Sample Clinic\",\n \"insuranceName\": \"Sample Insurance\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/outpatient/release-gl"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Access denied to the claim 'CL2601010000001H' due to provider/corporate/client scope.\",\n \"data\": null\n}"}],"_postman_id":"0d3f23fb-cd3d-4a31-a8e5-11b20e0614ab"},{"name":"4. Void Case","id":"1c32e037-94fa-413e-bff3-b85cc96533a7","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Pasien membatalkan janji temu sebelum konsultasi.\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/:claimNumber/void","description":"

Cancel a case that was registered but never progressed.

POST /v3/api/cases/{claimNumber}/void

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth scheme	`cambridge-api` (Bearer)
Permission	`cases:write`
Tenant scoping	Provider + corporate/client bindings
Content-Type	`application/json`

Description

For a booking that never happened, or a mis-keyed registration. The reason is stored against the claim and surfaces as remarkRejectVoid on Get Case Detail.

\n
Only a case still in Registered status may be voided through this API. The downstream Claim Service itself accepts Void from almost any status; Cambridge deliberately narrows that to the pre-guarantee-letter window. Once the guarantee letter has been released, voiding is an operations action, not an API action.
\n

Voiding is idempotent. A case that is already Void returns 200 with the same success body rather than an error, so a partner's retry after a timeout is safe.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	In	Type	Req.	Description
`claimNumber`	path	string	Yes	The claim/case number to void.
`Authorization`	header	string	Yes	`Bearer <access_token>`.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Description
`reason`	string	Yes	Why the case is being voided. Stored as the claim's `remarkRejectVoid`.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	Voided - or already void, which returns the same body.
`400`	Case has moved past `Registered`, downstream update failed, or body missing.
`403`	Provider or corporate/client scope boundary crossed.
`404`	No such claim number.

Response fields - `data`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`isSuccess`	boolean	No	Always `true` on a `200`.
`message`	string	No	Always `SUCCESS`.
`claimNumber`	string	No	The claim acted on.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	message	Cause
404	Case not found.	No such claim number.
403	Access denied to the specified claim.	Restricted tenant holding no provider/corporate/client bindings.
403	Access denied to the claim '{claimNumber}' due to provider scope.	The case's provider is outside the tenant's provider bindings.
403	Access denied to the claim '{claimNumber}' due to corporate/client scope.	The case is outside the tenant's corporate/client bindings.
400	This case can no longer be voided via the API.	The case has moved past `Registered` - for example the FGL is already released.
400	Failed to void the claim in the external Claim Service.	The downstream status update did not succeed.
400	Request payload cannot be empty.	Missing body.

\n
The status recorded downstream is Void with source Provider, attributed to the calling tenant user (or the tenant's internal service account for machine callers). The Claim Service sets the case's outdate automatically.
\n

The claim/case number to void.

\n","type":"text/plain"},"type":"any","value":"CL2601010000001H","key":"claimNumber"}]}},"response":[{"id":"2978eaa6-9ae1-42c7-9121-84fcf8b242db","name":"Voided","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Pasien membatalkan janji temu sebelum konsultasi.\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/:claimNumber/void","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","cases",":claimNumber","void"],"variable":[{"key":"claimNumber","value":"CL2601010000001H","description":"The claim/case number to void."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"OK\",\n \"data\": {\n \"isSuccess\": true,\n \"message\": \"SUCCESS\",\n \"claimNumber\": \"CL2601010000001H\"\n }\n}"},{"id":"7abeb2c3-e6b5-43e8-8ced-19347d96a0cc","name":"Already void - idempotent retry","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Pasien membatalkan janji temu sebelum konsultasi.\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/:claimNumber/void","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","cases",":claimNumber","void"],"variable":[{"key":"claimNumber","value":"CL2601010000001H","description":"The claim/case number to void."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"OK\",\n \"data\": {\n \"isSuccess\": true,\n \"message\": \"SUCCESS\",\n \"claimNumber\": \"CL2601010000001H\"\n }\n}"},{"id":"f676836b-b0bc-4736-9a62-a7ac50172cdc","name":"Too late to void","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Pasien membatalkan janji temu sebelum konsultasi.\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/:claimNumber/void","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","cases",":claimNumber","void"],"variable":[{"key":"claimNumber","value":"CL2601010000001H","description":"The claim/case number to void."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"This case can no longer be voided via the API.\",\n \"data\": null\n}"},{"id":"c86ffb73-0a18-4247-a497-03409718cc07","name":"Case not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Pasien membatalkan janji temu sebelum konsultasi.\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/cases/:claimNumber/void","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","cases",":claimNumber","void"],"variable":[{"key":"claimNumber","value":"CL2601010000001H","description":"The claim/case number to void."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Case not found.\",\n \"data\": null\n}"}],"_postman_id":"1c32e037-94fa-413e-bff3-b85cc96533a7"}],"id":"2579cc72-af46-4e56-897b-d4b72995af6b","description":"

The outpatient cashless sequence, in order. Create the case, validate each billing line, release the guarantee letter.

Void reverses step 1 while the case is still Registered. Once the guarantee letter is released, voiding is an operations action, not an API action.

\n","_postman_id":"2579cc72-af46-4e56-897b-d4b72995af6b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","name":"Cambridge API - V3","type":"folder"}}}],"id":"e8ec27f8-e56d-4927-ae50-24c4c73a8e5c","description":"

The Cases API. Search and read cases, check member and price eligibility, create a cashless case, validate its billing, release the guarantee letter, and void a case that never happened.

Telemedicine partner flow:

Member Eligibility -> Price Eligibility -> Create Case -> consultation -> Release GL\n                                                      |\n                     optional prescription -> Price Eligibility (with claimNumber)\n

All Cases endpoints use the cambridge-api scheme and are scoped to the tenant's data bindings.

\n","_postman_id":"e8ec27f8-e56d-4927-ae50-24c4c73a8e5c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","name":"Cambridge API - V3","type":"folder"}}},{"name":"Member","item":[{"name":"Search Member","item":[{"name":"Search Members","id":"1ff6309b-5b85-464e-a57e-1054337396e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"page\": 1,\n \"pageSize\": 10,\n \"cardNumber\": \"202601010-00000001\",\n \"memberName\": \"John Doe\",\n \"policyNumber\": \"POL0000000000001\",\n \"clientCode\": \"CLI01\",\n \"corporateName\": \"Sample Corporate\",\n \"memberStatus\": \"Active\"\n}","options":{"raw":{"language":"json"}}},"url":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/Members/search","description":"

Search the member book within the tenant's scope.

POST /v3/api/Members/search

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth scheme	`cambridge-api` (Bearer)
Permission	`members:search`
Tenant restriction	Tenants of type `Provider` are refused with `401`
Content-Type	`application/json`

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Req.	Default	Description
`page`	integer(int32)	No	`1`	Page number, minimum 1.
`pageSize`	integer(int32)	No	`10`	Page size, minimum 1, maximum 100.
`cardNumber`	string	No	-	Filter by card number.
`memberName`	string	No	-	Filter by member name.
`policyNumber`	string	No	-	Filter by policy number.
`clientCode`	string	No	-	Filter by client code.
`corporateName`	string	No	-	Filter by corporate name.
`memberStatus`	string	No	-	Filter by status, e.g. `Active`.
`corporateCode`, `companyName`, `productName`, `planCode`	string	No	-	Accepted but not applied. These bind on the request but are not forwarded to the downstream member search, so they currently have no effect on the result set.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	The page of members.
`400`	Paging validation failed. Framework error shape.
`401`	Caller's tenant type is `Provider`. Framework error shape.

Response fields - `data.list[]`

All sixteen fields are string and nullable - including the dates.

memberId, cardNumber, memberName, policyNumber, productCode, productName, planCode, planName, corporateCode, corporateName, clientCode, memberStatus, effectiveDate (string, not a date), expiredDate (string, not a date), relation, mappingId.

Envelope fields - page, view, totalPage, totalRecord, query, filter - are as described in the folder overview.

Failures

These use the framework error shape (PascalCase), not the V3 envelope. Status and Errors[].ErrorCode are always present; Errors[].Message is optional.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	ErrorCode	Message	Cause
401	UNAUTHORIZED	Search is unauthorized for Provider tenants.	Caller's tenant type is `Provider`.
400	VALIDATION_FAILED	Page must be greater than or equal to 1.	`page` below 1.
400	VALIDATION_FAILED	PageSize must be greater than or equal to 1.	`pageSize` below 1.
400	VALIDATION_FAILED	PageSize cannot exceed 100.	`pageSize` above 100.

Retrieve one member in full, including plans and family members.

GET /v3/api/Members/{cardNumber}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


Auth scheme	`cambridge-api` (Bearer)
Permissions	`members:search` (controller) and `members:read` (action)

Description

Needs both permissions - members:search at the controller and members:read at the action. A client holding only members:read is refused.

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	In	Type	Req.	Description
`cardNumber`	path	string	Yes	Member's card number.
`Authorization`	header	string	Yes	`Bearer <access_token>`.

Responses

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200`	The member.
`400`	Blank card number. Framework error shape.
`404`	No such member. Framework error shape.

Response fields - `data`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Null?	Description
`isActive`	boolean	No	The only non-nullable field on this response.
`memberId`, `cardNumber`, `memberName`, `policyNumber`, `insuranceNumber`	string	Yes	Identity.
`clientName`, `clientCode`, `corporateName`, `corporateCode`	string	Yes	Scope.
`dob`, `effectiveDate`, `expiredDate`	string	Yes	Strings, not dates.
`sex`	string	Yes	`M` / `F`.
`memberType`	string	Yes	e.g. `Principal`.
`maritalStatus`	string	Yes	`S` / `M`.
`productCode`, `productName`, `productType`	string	Yes	e.g. `group insurance`.
`relation`, `relationStatus`	string	Yes	e.g. `P` for principal.
`plans`	array	Yes	May be null, not just empty.
`familyMembers`	array	Yes	May be null, not just empty.

plans[] - benefitCode, benefitName, planCode, planName string; annualLimit number(decimal); planStart, planEnd string; isFamilyShared boolean; subBenefits array. All nullable.

plans[].subBenefits[] - benefitCode string, benefitName string, limit number(decimal). All nullable.

\n
This sub-benefit is much thinner than Member Eligibility's - three fields versus twenty. Partners needing isCashless, coShare or condition[] must call Member Eligibility, not Member Detail.
\n

familyMembers[] - memberId, memberName, cardNumber, relation, relationStatus. All string, all nullable.

Failures

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Body	Cause
400	`{\"Status\":400,\"Errors\":[{\"ErrorCode\":\"VALIDATION_FAILED\",\"Message\":\"Card number is required.\"}]}`	Blank card number.
404	`{\"Status\":404,\"Errors\":[{\"ErrorCode\":\"MEMBER_NOT_FOUND\",\"Message\":\"Member not found.\"}]}`	No such member.

Member's card number.

\n","type":"text/plain"},"type":"any","value":"202601010-00000001","key":"cardNumber"}]}},"response":[{"id":"17840ace-07ff-4a56-aedb-354c4ce5595d","name":"Member detail","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/Members/:cardNumber","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","Members",":cardNumber"],"variable":[{"key":"cardNumber","value":"202601010-00000001","description":"Member's card number."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"OK\",\n \"data\": {\n \"memberId\": \"00000000-0000-0000-0000-000000000001\",\n \"cardNumber\": \"202601010-00000001\",\n \"memberName\": \"John Doe\",\n \"policyNumber\": \"POL0000000000001\",\n \"insuranceNumber\": \"INS00000001\",\n \"isActive\": true,\n \"clientName\": \"Sample Insurance\",\n \"clientCode\": \"CLI01\",\n \"corporateName\": \"Sample Corporate\",\n \"corporateCode\": \"CORP01\",\n \"dob\": \"1990-01-01\",\n \"sex\": \"M\",\n \"memberType\": \"Principal\",\n \"maritalStatus\": \"S\",\n \"productCode\": \"PRD001\",\n \"productName\": \"Sample Product\",\n \"productType\": \"group insurance\",\n \"effectiveDate\": \"2026-01-01T00:00:00+00:00\",\n \"expiredDate\": \"2026-12-31T00:00:00+00:00\",\n \"relation\": \"P\",\n \"relationStatus\": \"P\",\n \"plans\": [\n {\n \"benefitCode\": \"IP\",\n \"benefitName\": \"INPATIENT\",\n \"planCode\": \"PLAN-001\",\n \"planName\": \"Sample Inpatient Plan (PLAN-001)\",\n \"annualLimit\": 0,\n \"planStart\": \"2025-12-31T17:00:00\",\n \"planEnd\": \"2026-12-30T17:00:00\",\n \"isFamilyShared\": false,\n \"subBenefits\": [\n {\n \"benefitCode\": \"A1B2C3D4\",\n \"benefitName\": \"Additional Benefit - Sample Rider (For Dependants only)\",\n \"limit\": 30000000\n }\n ]\n }\n ],\n \"familyMembers\": []\n }\n}"},{"id":"f703b238-0b0e-41db-8953-66b43b62cc0c","name":"Blank card number","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/Members/:cardNumber","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","Members",":cardNumber"],"variable":[{"key":"cardNumber","value":"202601010-00000001","description":"Member's card number."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 400,\n \"Errors\": [\n {\n \"ErrorCode\": \"VALIDATION_FAILED\",\n \"Message\": \"Card number is required.\"\n }\n ]\n}"},{"id":"0e6796fd-7e45-450e-9f60-e8b920094a2b","name":"Member not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app/v3/api/Members/:cardNumber","host":["https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app"],"path":["v3","api","Members",":cardNumber"],"variable":[{"key":"cardNumber","value":"202601010-00000001","description":"Member's card number."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": 404,\n \"Errors\": [\n {\n \"ErrorCode\": \"MEMBER_NOT_FOUND\",\n \"Message\": \"Member not found.\"\n }\n ]\n}"}],"_postman_id":"ee26024b-0843-4a96-8119-8b1e8d85065a"}],"id":"dd259789-a274-4ac9-b8d4-742bca9976c5","description":"

Both Members endpoints use the cambridge-api scheme.

The controller-level policy is members:search, so an API client needs members:search even to fetch a single member's detail, plus members:read for the detail action itself.

Tenants of type Provider are refused on member search with 401.

\n","_postman_id":"dd259789-a274-4ac9-b8d4-742bca9976c5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","name":"Cambridge API - V3","type":"folder"}}}],"id":"737c732a-c109-4535-bb1b-e3133707200c","description":"

The Members API. Search the member book and read a single member's detail including plans and sub-benefits.

\n","_postman_id":"737c732a-c109-4535-bb1b-e3133707200c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","name":"Cambridge API - V3","type":"folder"}}}],"id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a","description":"

The v3.0+ integration surface: OAuth, Cases and Members.

Authorisation is configured on this folder - Bearer Token, value . Every request below inherits it. Only Get Token overrides to No Auth.

Run OAuth > Get Token first; its post-response script stores accessToken for every other request.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"_postman_id":"057eb0da-9a5a-4d61-87a0-2c8e333eb93a"}],"id":"3de7590e-fbb9-4b52-a65e-c510e14f7b96","description":"

Cambridge OpenAPI V3 - Cases & Member

The v3 integration surface for partners: OAuth, Cases and Members. Every request is authenticated with a Cambridge-signed JWT, authorised against the permissions held by the caller, and scoped to the data that caller's tenant is allowed to see before any downstream call is made.

The tenant-administration endpoints under /v3/api/admin/... are out of scope for this documentation; they serve the internal console, not integrating partners.

Changelog

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Date	Description	Version
Aug 2026	Added Void a Case (`POST /v3/api/cases/{claimNumber}/void`) - cancels a case that has not yet had its guarantee letter released; a retry against an already-voided case succeeds as a no-op.	3.2.0
Aug 2026	Added Price Eligibility (`POST /v3/api/cases/price-eligibility`) - checks whether an amount is covered before a case exists. Binary in money terms; never discloses the member's remaining limit or visit count.	3.1.0
May 2026	V3 multi-tenant OAuth, Cases Search, Get Case Detail, Create Case, Validate Outpatient Billing, Release Guarantee Letter, Member Eligibility, Member Search and Get Member Detail.	3.0.0
Oct 2025	New API for submitting claim history; improved performance.	2.7.0
Feb 2025	Changed the Find By Card Number response structure; added an endpoint for retrieving a member's benefit; updated the staging base URL.	2.6.1
Jan 2025	List Member by Client Code; enhanced Provider List filtering by distance.	2.5.3
Oct 2024	Claim, Member's Data and Provider List.	2.4.4
Aug 2024	Enrollment Process.	1.0.0

1. Overview

V1 and V2 of the Cambridge API were single-tenant proxies in front of NOVA. V3 is a first-party, multi-tenant identity and authorisation system.

1.1 The integration token

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n


JWT audience / auth scheme	`cambridge-api`
Identity	An API Client (client ID + secret)
Obtained from	`POST /v3/api/oauth/token`
Access token lifetime	60 minutes
Refresh mechanism	None - request a new token
Gated by	Permissions (`cases:read`, `members:search`, ...)

Client credentials are issued by a tenant administrator through the console. If you need a client ID and secret, or a permission added to an existing one, ask the tenant's administrator rather than calling any endpoint yourself.

Credentials are never stored in this collection. {{clientId}} and {{clientSecret}} are secret-typed environment variables with no saved value - supply them in your own environment at integration time.

1.2 Tenant scoping (data bindings)

Every tenant has a type - Client, Corporate, Broker, Provider or Full - and a set of data bindings, the codes it is permitted to act within:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Binding type	Meaning
`ProviderCode`	The clinics/hospitals this tenant operates.
`CorporateCode`	The corporates whose members this tenant may act for.
`ClientCode`	The insurer/client whose book this tenant may act within.
`CustomerGroupCode`	Customer group scoping.
`BrokerCode`	Broker scoping.

Bindings are embedded in the token and re-checked server-side on every scoped operation. A tenant of type Full is unrestricted and skips these checks; every other tenant type must pass them. A restricted tenant holding no bindings at all is denied rather than granted everything.

Scoping failures return 403 with a message naming the boundary that was crossed - see each endpoint's failure table.

Search results are already restricted to the tenant's bindings - a search never needs to be filtered again on the caller's side.

2. Conventions

2.1 Base path and versioning

Versioning is by URL segment. Every V3 route sits under /v3/api:

Staging:     https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app\nProduction:  (to be confirmed)\n\n<host>/v3/api/<resource>\n

Routing is case-insensitive, so /v3/api/members/... and /v3/api/Members/... reach the same action.

No shorter alias is served. /v3/cases/search returns 404 - verified against staging on 2026-09-21. Only the /v3/api/... form is served by the application itself; any shorter alias would have to be provided by a gateway or reverse proxy in front of Cambridge.

2.2 Success envelope

The Cases and Members endpoints wrap their payload in the standard V3 envelope (V3Response<T>):

{\n  \"status\": \"success\",\n  \"message\": \"OK\",\n  \"data\": { }\n}\n

List endpoints put V3ListData<T> in data:

{\n  \"status\": \"success\",\n  \"message\": \"OK\",\n  \"data\": {\n    \"list\": [],\n    \"page\": 1,\n    \"view\": 10,\n    \"totalPage\": 0,\n    \"totalRecord\": 0,\n    \"query\": null,\n    \"filter\": { }\n  }\n}\n

view is the page size; filter echoes back the request that produced the page.

The token endpoint deliberately does not use the envelope, because it is OAuth-shaped rather than resource-shaped: POST /v3/api/oauth/token returns the standard OAuth token object at the top level.

2.3 Field presence - read this before writing a deserialiser

Every field documented on a Cases or Members response is always present. A field with no value arrives as \"field\": null, never as a missing key. Most fields are nullable; a client may index every key but must null-check nearly all of them.

Because presence is universal, the response tables in this documentation carry a Null? column rather than a required column. The three non-enveloped shapes - the token response, the framework error and the RFC 7807 document - are the only places where presence varies, and they are marked individually.

2.4 Error shapes

There are four distinct error bodies in V3. An integration should handle all four.

(a) Handled business failures on Cases - returned by the Cases controller itself, in the V3 envelope with status: \"error\" and data: null:

{\n  \"status\": \"error\",\n  \"message\": \"Case not found\",\n  \"data\": null\n}\n

(b) Framework exceptions - thrown by the Members service and rendered by the exception middleware. Note the PascalCase property names; this shape does not follow the camelCase envelope above, because the middleware writes the body outside the MVC pipeline:

{\n  \"Status\": 404,\n  \"Errors\": [\n    { \"ErrorCode\": \"MEMBER_NOT_FOUND\", \"Message\": \"Member not found.\" }\n  ]\n}\n

Status and Errors[].ErrorCode are always present; Errors[].Message is optional.

(c) Model-binding validation - a request that fails a required or type check is rejected before the handler runs, as an RFC 7807 problem document:

{\n  \"type\": \"https://tools.ietf.org/html/rfc9110#section-15.5.1\",\n  \"title\": \"One or more validation errors occurred.\",\n  \"status\": 400,\n  \"errors\": { \"CardNumber\": [\"The CardNumber field is required.\"] }\n}\n

errors appears only on binding failures.

(d) Authentication / authorisation refusals - a missing, expired or wrong-audience token returns 401 with an empty body and a WWW-Authenticate: Bearer header; a token that fails a permission policy returns 403 with an empty body. The JSON 403 bodies documented per endpoint are scoping refusals, raised after authorisation has already passed.

\n
The empty 401 is served with content-type: text/html and Content-Length: 0. A strict client that branches on content-type before checking length may trip on this - check the status code and length, not the content type.
\n

2.5 Permission catalogue

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Permission	Grants
`cases:search`	Search cases/claims within the tenant's scope.
`cases:read`	Read case detail, member eligibility and price eligibility.
`cases:write`	Submit, validate, release and void cases within the tenant's scope.
`members:search`	Search members within the tenant's scope.
`members:read`	Read a member's detail.

A tenant holds a permission ceiling; an API client may only be granted permissions inside it, so a permission your integration needs may have to be added to the tenant first.

2.6 Endpoint inventory

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Method	Path	Auth scheme	Gate
POST	`/v3/api/oauth/token`	none	-
GET	`/v3/api/cases/search`	`cambridge-api`	`cases:search`
GET	`/v3/api/cases/{claimNumber}`	`cambridge-api`	`cases:read`
POST	`/v3/api/cases`	`cambridge-api`	`cases:write`
POST	`/v3/api/cases/validate-billing`	`cambridge-api`	`cases:write`
POST	`/v3/api/cases/outpatient/release-gl`	`cambridge-api`	`cases:write`
POST	`/v3/api/cases/member-eligibility`	`cambridge-api`	`cases:read`
POST	`/v3/api/cases/price-eligibility`	`cambridge-api`	`cases:read`
POST	`/v3/api/cases/{claimNumber}/void`	`cambridge-api`	`cases:write`
POST	`/v3/api/Members/search`	`cambridge-api`	`members:search`
GET	`/v3/api/Members/{cardNumber}`	`cambridge-api`	`members:search` + `members:read`

2.7 Dates, numbers and enums

Request date fields (dob, indate) are strings in yyyy-MM-dd. treatmentDate is a full ISO-8601 datetime with offset.
Cases responses return dates as ISO-8601 datetimes. Members responses return them as pass-through strings - do not assume they parse.
Money is a JSON number in the plan's currency (IDR unless stated otherwise) - never a formatted string.
claimStatus: New Case, Registered, FGL Review, FGL Released, Payment In Progress, Paid, Void.
treatmentType / tipePerawatan: Rawat inap (inpatient), Rawat jalan (outpatient).

2.8 Status codes at a glance

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Meaning in V3
200	Success - including a not-eligible price-eligibility verdict and an already-void case.
400	Validation failure, business rule refusal, or a downstream failure Cambridge handled.
401	No/invalid/expired token, wrong audience, or a `Provider` tenant calling member search.
403	Permission policy failed (empty body), or a tenant scoping boundary was crossed (JSON body).
404	Case or member not found - or outside the caller's tenant.
500	Unhandled error; the body carries no detail beyond a generic message.

3. Example data

Every example in this folder follows one fictional journey, so the values can be traced end to end:

\n
John Doe, card 202601010-00000001, telemedicine benefit 00000001 under plan TELE-001, treated at Sample Clinic (PRV001), producing claim CL2601010000001H.
\n

No value in any example is real. Card numbers, claim numbers, benefit codes, plan codes, internal IDs, names and emails are synthetic and structurally valid.

4. Appendix - JWT claims

The cambridge-api token (audience cambridge-api, 60 minutes) carries:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Claim	Value
`sub`	API client's internal ID.
`tenant_id`	Owning tenant.
`tenant_type`	`Client`, `Corporate`, `Broker`, `Provider` or `Full`.
`client_id`	The public client identifier.
`permissions`	JSON array of permission codes.
`bindings`	JSON array of `{ \"type\": \"...\", \"key\": \"...\" }`.

It is HMAC-SHA256 signed with the shared JWT key and validated on issuer, audience, lifetime and signature. The claims are a snapshot taken at issue time - treat the token as read-only and request a new one after any permission or binding change.

\n","_postman_id":"3de7590e-fbb9-4b52-a65e-c510e14f7b96","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"8f4d874e-b270-46dd-a3bd-07ae76c56d25","id":"8f4d874e-b270-46dd-a3bd-07ae76c56d25","name":"Cambridge API","type":"folder"}}}],"id":"8f4d874e-b270-46dd-a3bd-07ae76c56d25","description":"

This Cambridge API contains features that can be used in your members management system.

HTTP(S) Request

Cambridge OpenAPI can be requested through HTTP(S) Request to Cambridge OpenAPI Base URL endpoint. The HTTP(S) Header has to be used to allow proper authentication.

API Base URL

Sandbox Environment: Base URL for Staging
\n
Production Environtment: Base URL for Production
\n

HTTP(S) Header

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Value	Definition
Content-Type	application/json	The Content-Type field indicates that JSON type is acceptable to send to the recipient
Accept	application/json	The Accept field is used to specify that JSON type is acceptable for the response
Authorization	BEARER_TOKEN	The Authorization field credentials can be found in Login Responses.

Content-Type and Accept Header

In Cambridge API, the input and output parameters of the methods will be in JSON format. To accept JSON input and output parameters, you need to add the following HTTP(S) header:

Content-Type: application/json
\n
Accept: application/json
\n

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"33d4caeb-abc9-4265-ad08-49919ab5e41d","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"1ace515b-3de3-480c-8cde-d45e482ca94b","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"8f4d874e-b270-46dd-a3bd-07ae76c56d25"}],"event":[{"listen":"prerequest","script":{"id":"55cedf42-7cad-4920-864a-8d6c8b6922ca","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fe0aa6ea-df49-4a47-949c-ecc0b8197c87","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://hms-id-svc-cambridge-stg-928498666018.asia-southeast2.run.app","type":"string","description":"Staging. Production to be confirmed."},{"key":"key","value":"","type":"string"},{"key":"server","value":"","type":"string"},{"key":"accessToken","value":"","type":"string","description":"Written by Get Token's post-response script."},{"key":"BearerToken","value":"","type":"string","description":"Written by Login's post-response script."}]}

Changelogs

Overview

Which version do I use?

Business flow

Enrolment

Effective date and renewal

Change plan

Terminate and suspend

Re-activate

Claims

Members and providers

Features

Setting Up

Reference

Authorization

V1 & V2 - client key and server key

V3 - OAuth client credentials

Keeping credentials safe

Description

Request body

Responses

Response fields - data

Login reports failure as HTTP 200

Description

Request body

Responses

Response fields - data[]

Failures

Description

Parameters

Responses

Response fields - data[]

Description

Request body - array item

Responses

Description

Request body - array item

Responses

Description

Request body

Responses

Response fields - data[]

Failures

Description

Request body

Responses

Response fields - data[]

Failures

Description

Request body

Responses

Response fields - data[]

Failures

Description

Request body

Responses

Response fields - data[]

Failures

Description

Request body

Responses

Response fields - data[]

Failures

Description

Request body

Responses

Response fields - data[]

Failures

Description

Request body

Responses

Response fields - data[]

Failures

Description

Request body

Responses

Response fields - data[]

Failures

Description

Request body

Response fields - `data`

Response fields - `data[]`

Response fields - `data[]`

Response fields - `data[]`

Response fields - `data[]`

Response fields - `data[]`

Response fields - `data[]`

Response fields - `data[]`

Response fields - `data[]`

Response fields - `data[]`

Response fields - `data[]`

Response fields - `claims`

Response fields - `plans[]`

(a) Family A - `data` only