For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
    • Home
  • API Reference
        • POSTIdentify Individual
        • POSTImmunisation History Details
        • POSTMedical Contraindication History
        • POSTNatural Immunity History
        • POSTVaccine Trial History
        • POSTAdd Additional Vaccine Indicator
        • POSTRemove Additional Vaccine Indicator
        • POSTIndigenous Status Update
        • POSTImmunisation History Statement
        • POSTUpdate Encounter
  • Guides
    • Minor ID Setup
    • Architecture
    • Security & Governance
    • PRODA
    • DVA Integration
    • AIR Integration
    • Integration test data
    • Troubleshooting
LogoLogo
API ReferenceAIRIndividual Details

Immunisation History Statement

||View as Markdown|
POST
/AIR/v1/individual/immunisation-history/statement
POST
/AIR/v1/individual/immunisation-history/statement
$curl -X POST https://api.rebateright.com.au/AIR/v1/individual/immunisation-history/statement \
>     -H "x-api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "individualIdentifier": "wXrN7bKidsrEkh89yldqZRw99uzP6WZJfEgIe4PEaEQ1TyUZsqOSEnqCM0BvbRF-FoHdgZgtg4iynmUuQamZdgGPH8QDag8rwFax7MI0zBpBaQnsaznfCA==",
>  "individualDateOfBirth": "17042012",
>  "informationProvider": {
>    "providerNumber": "T39126X"
>  }
>}'
200Success
1{
2  "statusCode": "AIR-I-1100",
3  "codeType": "AIRIBU",
4  "message": "Your request was successfully processed.",
5  "immunisationHistoryStatement": {
6    "fileContent": "JVBERi0xLjUKJfbk/N8KMSAwIG9iago8PAovUGFnZU1vZGUgL1VzZU91dGxpbmVzCi9UeXBlIC9DYXRhbG9nCi9QYWdlcyAyIDAgUg... (base64-encoded PDF, truncated for readability)"
7  },
8  "correlationId": "urn:uuid:MDE00000000000000000000000"
9}
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`. Requires an `individualIdentifier` from a prior [Identify Individual](/api-reference/air/individual-details/identify-individual) call. For shared response patterns and the full status-code list, see [AIR Integration](/air). #### What's in the statement The PDF shows every vaccine recorded on AIR (including overseas vaccines reported to the individual's provider), assessed up-to-date status for under-7s and 14–19-year-olds, and any planned catch-up dates. #### 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. #### Status Codes | Code | Meaning | |---|---| | `AIR-I-1100` | Statement generated. `fileContent` returned. | | `AIR-E-1005` | Validation errors (e.g. `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. |
Was this page helpful?
Previous

Indigenous Status Update

Next

Update Encounter

Built with

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.

Requires an individualIdentifier from a prior Identify Individual call.

For shared response patterns and the full status-code list, see AIR Integration.

What’s in the statement

The PDF shows every vaccine recorded on AIR (including overseas vaccines reported to the individual’s provider), assessed up-to-date status for under-7s and 14–19-year-olds, and any planned catch-up dates.

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.

Status Codes

CodeMeaning
AIR-I-1100Statement generated. fileContent returned.
AIR-E-1005Validation errors (e.g. AIR-E-1061 invalid identifier).
AIR-E-1058Individual’s record cannot be viewed.
AIR-E-1078Statement cannot be generated or viewed at this time.

Authentication

x-api-keystring
API Key authentication via header
x-minor-idstring
API Key authentication via header

Request

This endpoint expects an object.
individualIdentifierstringRequired
Opaque token from a prior Identify Individual call.
individualDateOfBirthstringRequired
DDMMYYYY format.
informationProviderobjectRequired

Response

OK
statusCodestring
codeTypestring
messagestring
immunisationHistoryStatementobject or null

Present on success. null on errors.

errorslist of objects or null
correlationIdstring