Tenancy Bond API

The Tenancy Bond API allows users to interact with Tenancy Services to allow registering as a landlord in the system, lodging bonds and checking the status of a bond lodgement.

Using the API

Follow these steps to get up and running:

Read the technical details

View the API definition in our developer portal here. You can also download the definition for viewing in Swagger Editor, SwaggerHub, or other tools.

Subscribe to the API

Log in and subscribe to the Tenancy Bond API Product using the Authorisation code flow/3-legged OAuth method. Our API support team may request further information before the subscription can be approved.
View the Tenancy Bond developer registration and Authentication guide v1.0 for user set up information.

Generate an API subscription key

For full details on how to generate an API subscription key please see here.

Once your subscription has been approved you will be able use your API credentials to successfully call the API. Use the sandbox key and sandbox endpoints in your software development. Once you've completed testing simply use your production keys to access the live service.

Generate an OAuth2 token for user authorisation

When calling the API you must have both a subscription key and a three-legged OAuth bearer token associated with a Landlord user that has provided consent for your product to access their data.

Consent is provided by the end user logging in with the RealMe account that they use on the Tenancy Services site. The 3-legged token that is generated in this process can then be used in future requests for retrieving bond and bond lodgement details that the landlord is associated with.

Refer to the fee payment section below to see how the payments for bond lodgements are processed.

Technical details of how to generate this token are available here.