Immunisation History Statement | RebateRight

curl -X POST https://test-api.rebateright.com.au/AIR/v1/individual/immunisation-history/statement \
     -H "x-minor-id: <minorId>" \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "individualIdentifier": "wXrN7bKidsrEkh89yldqZRw99uzP6WZJfEgIe4PEaEQ1TyUZsqOSEnqCM0BvbRF-FoHdgZgtg4iynmUuQamZdgGPH8QDag8rwFax7MI0zBpBaQnsaznfCA==",
  "individualDateOfBirth": "17042012",
  "informationProvider": {
    "providerNumber": "T39126X"
  }
}'

{
  "statusCode": "AIR-I-1100",
  "codeType": "AIRIBU",
  "message": "Your request was successfully processed.",
  "immunisationHistoryStatement": {
    "fileContent": "JVBERi0xLjUKJfbk/N8KMSAwIG9iago8PAovUGFnZU1vZGUgL1VzZU91dGxpbmVzCi9UeXBlIC9DYXRhbG9nCi9QYWdlcyAyIDAgUg... (base64-encoded PDF, truncated for readability)"
  },
  "correlationId": "urn:uuid:MDE00000000000000000000000"
}

Can I give this person their official immunisation history statement?

This endpoint produces it: the Australian Immunisation Register (AIR) statement as a PDF, returned as a base64 string.

Generate the individual’s official AIR immunisation history statement as a PDF. The response carries the PDF as a base64-encoded string in immunisationHistoryStatement.fileContent.

Send the individualIdentifier that Identify Individual returned.

For shared response patterns and the full status-code list, see AIR Integration. For what your software must show, see Display requirements.

What’s in the statement

The PDF shows every vaccine recorded on AIR for the individual. AIR uses one of 3 templates, chosen by the individual’s age when the statement is generated: under 10, 10 to under 20, and 20 and over. The immunisation status, including any planned catch-up, appears only for individuals under 20.

This endpoint returns the complete immunisation history statement. COVID-19 and influenza statements and international COVID-19 vaccination certificates are not available through this endpoint.

Decoding the PDF

Base64-decode fileContent into bytes and write them to a .pdf file. The result is a Services Australia-issued statement suitable for the individual to keep or print. Show the PDF as it is, without altering it.

Status Codes

Code	Meaning
`AIR-I-1100`	Statement generated. `fileContent` returned.
`AIR-E-1005`	Validation errors, such as `AIR-E-1061` (invalid identifier).
`AIR-E-1058`	Individual’s record cannot be viewed.
`AIR-E-1078`	Statement cannot be generated or viewed at this time.

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.

individualIdentifierstringRequired

Opaque token that Identify Individual returned.

individualDateOfBirthstringRequired

DDMMYYYY format.

informationProviderobjectRequired

Response

statusCodestringOptional

codeTypestringOptional

messagestringOptional

immunisationHistoryStatementobject or nullOptional

Present on success. null on errors.

errorslist of objects or nullOptional

correlationIdstringOptional