Authorisation | RebateRight

curl -X POST https://api.rebateright.com.au/AIR/v1/authorisation/access/list \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "informationProvider": {
    "providerNumber": "T39126X"
  }
}'

{
  "statusCode": "AIR-I-1100",
  "codeType": "AIRIBU",
  "message": "Your request was successfully processed.",
  "accessList": [
    {
      "code": "IDV",
      "name": "Identify individual details",
      "hasAccess": true
    },
    {
      "code": "IDGST",
      "name": "Update Indigenous status",
      "hasAccess": true
    },
    {
      "code": "ADINDT",
      "name": "Add/Remove additional vaccine indicator",
      "hasAccess": true
    },
    {
      "code": "NATIMM",
      "name": "Record natural immunity",
      "hasAccess": false
    },
    {
      "code": "MEDCON",
      "name": "Record medical contraindication",
      "hasAccess": false
    },
    {
      "code": "RECUPD",
      "name": "Update vaccination encounter",
      "hasAccess": true
    },
    {
      "code": "RECENC",
      "name": "Record encounter",
      "hasAccess": true
    },
    {
      "code": "NXTDUE",
      "name": "Record planned catchup date",
      "hasAccess": true
    },
    {
      "code": "IHSPDS",
      "name": "Get immunisatiom history statement in PDF",
      "hasAccess": true
    },
    {
      "code": "GETIHS",
      "name": "Get immunisation history details",
      "hasAccess": true
    },
    {
      "code": "GETMEDCON",
      "name": "Get medical contraindication history",
      "hasAccess": true
    },
    {
      "code": "GETNATIMM",
      "name": "Get natural immunity history",
      "hasAccess": true
    },
    {
      "code": "GETVACTRL",
      "name": "Get vaccine trial history",
      "hasAccess": true
    },
    {
      "code": "GETCOV19PDF",
      "name": "Get COVID-19 digital certificate in PDF",
      "hasAccess": true
    }
  ],
  "correlationId": "urn:uuid:MDE00000a74e9d1a52d34c66"
}

What is this provider authorised to do on the AIR?

That is the question this endpoint answers: the Australian Immunisation Register (AIR) capabilities the information provider holds.

Check which Australian Immunisation Register (AIR) capabilities an information provider is authorised for. Returns an accessList of codes, each with hasAccess: true or false. Use it to decide which AIR actions to expose in your interface.

The information provider is the entity sending data to AIR — not necessarily the immunisation provider who administered the vaccine. A provider can be registered for AIR but not authorised for every capability (recording natural immunity, for example, is granted separately from recording encounters).

Call this once on first connection, and again if the provider’s authorisations change at Services Australia.

Capability Codes

Code	Capability	Display label
`IDV`	Identify individual details	Identify Individual
`IDGST`	Update Indigenous status	Indigenous Status
`ADINDT`	Add or remove additional vaccine indicator	Additional Vaccines Required
`NATIMM`	Record natural immunity	Natural Immunity
`MEDCON`	Record medical contraindication	Medical Contraindication
`RECUPD`	Update vaccination encounter	Update Encounter
`RECENC`	Record encounter	Record Encounter
`NXTDUE`	Record planned catch-up date	Planned Catch Up
`IHSPDS`	Get immunisation history statement (PDF)	Immunisation History Statement
`GETIHS`	Get immunisation history details	Immunisation History
`GETMEDCON`	Get medical contraindication history	Medical Contraindication History
`GETNATIMM`	Get natural immunity history	Natural Immunity History
`GETVACTRL`	Get vaccine trial history	Vaccine Trial History
`GETCOV19PDF`	Get COVID-19 digital certificate (PDF)	—

Show the Display label in your interface for any capability returning hasAccess: true. Services Australia certification (NOI) requires the exact wording.

Status Codes

Returns AIR-I-1100 on success or AIR-E-1005 on validation errors. See AIR Integration for the response envelope, the full code tables, and the HTTP 200 / verbatim-display rules that apply to every AIR endpoint.

<Card title="What is this provider authorised to do on the AIR?"> That is the question this endpoint answers: the Australian Immunisation Register (AIR) capabilities the information provider holds. </Card> Check which Australian Immunisation Register (AIR) capabilities an information provider is authorised for. Returns an `accessList` of codes, each with `hasAccess: true` or `false`. Use it to decide which AIR actions to expose in your interface. The **information provider** is the entity sending data to AIR — not necessarily the immunisation provider who administered the vaccine. A provider can be registered for AIR but not authorised for every capability (recording natural immunity, for example, is granted separately from recording encounters). Call this once on first connection, and again if the provider's authorisations change at Services Australia. #### Capability Codes | Code | Capability | Display label | |---|---|---| | `IDV` | Identify individual details | Identify Individual | | `IDGST` | Update Indigenous status | Indigenous Status | | `ADINDT` | Add or remove additional vaccine indicator | Additional Vaccines Required | | `NATIMM` | Record natural immunity | Natural Immunity | | `MEDCON` | Record medical contraindication | Medical Contraindication | | `RECUPD` | Update vaccination encounter | Update Encounter | | `RECENC` | Record encounter | Record Encounter | | `NXTDUE` | Record planned catch-up date | Planned Catch Up | | `IHSPDS` | Get immunisation history statement (PDF) | Immunisation History Statement | | `GETIHS` | Get immunisation history details | Immunisation History | | `GETMEDCON` | Get medical contraindication history | Medical Contraindication History | | `GETNATIMM` | Get natural immunity history | Natural Immunity History | | `GETVACTRL` | Get vaccine trial history | Vaccine Trial History | | `GETCOV19PDF` | Get COVID-19 digital certificate (PDF) | — | <Note> Show the **Display label** in your interface for any capability returning `hasAccess: true`. Services Australia certification (NOI) requires the exact wording. </Note> #### Status Codes Returns `AIR-I-1100` on success or `AIR-E-1005` on validation errors. See [AIR Integration](/air) for the response envelope, the full code tables, and the HTTP 200 / verbatim-display rules that apply to every AIR endpoint.

Authentication

x-api-keystring

API Key authentication via header

x-minor-idstring

API Key authentication via header

Request

This endpoint expects an object.

informationProviderobjectRequired

Response

statusCodestringOptional

AIR status code. AIR-I-* indicates success; AIR-E-* indicates a validation error. See the Status Codes table.

codeTypestringOptional

Code-type category. AIRIBU on success; AIREBU on validation errors.

messagestringOptional

Status message from AIR.

accessListlist of objectsOptional

Capabilities available to this information provider on AIR. Present on success (AIR-I-1100).

errorslist of objectsOptional

One entry per field-level problem with the request. Present on validation errors (AIR-E-1005).

correlationIdstringOptional

Unique request identifier. Format urn:uuid:{MinorId}{16 hex chars}. Include in support tickets so we can trace the request.

Code

Capability

Display label

IDV

Identify individual details

Identify Individual

IDGST

Update Indigenous status

Indigenous Status

ADINDT

Add or remove additional vaccine indicator

Additional Vaccines Required

NATIMM

Record natural immunity

Natural Immunity

MEDCON

Record medical contraindication

Medical Contraindication

RECUPD

Update vaccination encounter

Update Encounter

RECENC

Record encounter

Record Encounter

NXTDUE

Record planned catch-up date

Planned Catch Up

IHSPDS

Get immunisation history statement (PDF)

Immunisation History Statement

GETIHS

Get immunisation history details

Immunisation History

GETMEDCON

Get medical contraindication history

Medical Contraindication History

GETNATIMM

Get natural immunity history

Natural Immunity History

GETVACTRL

Get vaccine trial history

Vaccine Trial History

GETCOV19PDF

Get COVID-19 digital certificate (PDF)

—