Immunisation History Statement

View as Markdown
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. |

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