API Documentation

Getting Started

To use the Aged Care Ban Checker API, you'll need an API key. Once you have your key, you can start making requests to our endpoint.

Include your API key in the header of each request:

Authorization: Bearer YOUR_API_KEY

Make a POST request to the following endpoint:

https://api.agedcarebancheck.com/v1/check

Send a JSON object with the following structure:

{
  "name": "John Doe",
  "dateOfBirth": "1980-01-01"
}

You'll receive a JSON response with the check result:

{
  "status": "clear",
  "message": "No banning order found",
  "checkedAt": "2023-06-01T12:00:00Z"
}