Get Participants | RebateRight

curl -X POST https://test-api.rebateright.com.au/Medicare/getparticipants/v1 \
     -H "x-minor-id: <minorId>" \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "participantType": "F"
}'

{
  "participant": [
    {
      "name": "ITEST Subsequent WS Test Health Fund",
      "id": "ITS",
      "service": [
        "In Hospital Claim",
        "Online Eligibility Check"
      ]
    },
    {
      "name": "Mock Health Fund V2",
      "id": "TST",
      "service": [
        "In Hospital Claim",
        "In Patient Medical Claim - Agreements",
        "In Patient Medical Claim - Billing Agents",
        "In Patient Medical Claim - Patient Claims",
        "In Patient Medical Claim - Schemes",
        "Online Eligibility Check",
        "Online Eligibility Check - Fund",
        "Online Eligibility Check - Overseas",
        "Overseas Claim - Agreements",
        "Overseas Claim - Billing Agents",
        "Overseas Claim - Patient Claims",
        "Overseas Claim - Schemes"
      ]
    },
    {
      "name": "Department of Veterans' Affairs",
      "id": "DVA",
      "service": [
        "In Hospital Claim"
      ]
    }
  ],
  "correlationId": "urn:uuid:MDE00000ea492708f00148b9"
}

Which health funds take part, and what does each one accept?

That is the question this endpoint answers, with each fund’s code and the claims and checks it accepts.

Test environment only. Services Australia is certifying this service, and it reaches production once certified.

Send participantType as F. The response lists every participating health fund, and the Department of Veterans’ Affairs (DVA).

Several funds can share a name, so identify each fund by its id. Fund codes sets out where to send each code, when to refresh your list, and the service text for each claim type and check a fund accepts.

The example response shows 3 of the participants the test environment returns. TST is the fund the test data uses.

Validation errors (`400`)

Code	Meaning
`9202`	`participantType` is not `F`.
`5`, with `codeType` `DHSEIN`	The request does not match the expected structure, such as a missing `participantType`. `message` names the problem.

Authentication

x-api-keystring

API Key authentication via header

x-minor-idstring

Your Minor ID is 3 uppercase letters followed by 5 digits, such as MDE00000. Send the Minor ID exactly as issued. A malformed value returns 400 with the text The Minor ID is not valid. on every endpoint.

Request

This endpoint expects an object.

participantTypeenumRequired

Must be F. The response also includes DVA.

Code	Meaning
`F`	Health funds

Allowed values:

Response

participantlist of objects

One entry for each participating health fund, and one for DVA.

correlationIdstring

Unique identifier for this transaction. Use it for tracing and support.

Errors

400

Bad Request Error

Validation errors (400)