Skip to main content

FamilyBoost registrations | You can now register for FamilyBoost in myIR. We suggest you register before claims open on 1 October 2024. Find out more: Register for FamilyBoost

The notifications service delivers event notifications to software platforms. 

How the notifications service works

The notifications service delivers read-only notifications to software platforms, with the necessary data to describe the underlying event. The receiver of the notification will decide if further information and/or action is needed to respond to the notification.

There are 5 general categories of notification.

  • Event notifications - notification about significant events that have occurred.
  • Reminders - reminder of future events.
  • Request for information - requests from us for information, typically the uploading of a document of a specific type.
  • Errors - something that is not correct.
  • Action required - something that needs to be done.

Sub-categories work out if the notification is relevant to the calling party.

For access to myIR File Upload and Gateway Services detailed technical documentation, register your organisation or login to Gateway Customer Support Portal using the links below.

Use the Getting started guide to find out how to access our sandbox (mock services) and test environments.

Getting started guide

Gateway service capability for the notifications service

The notifications service provides the following capability through a defined service operation.

Service operation Description
Read Retrieve a read-only notification from Inland Revenue.

Supporting services

Identity and access services

Software intermediation service

Intermediation service  

Document service

Last updated: 28 Aug 2024
Jump back to the top of the page