Help Centre

For Developers

How to use quickclaim's NDIS API package

This article explains how to access your data using the quickclaim's NDIS API package.

What is NDIS Native API?

NDIS Native API is a group of APIs developed and maintained by the NDIA. You can access these APIs via the quickclaim network securely and easily. quickclaim is an official partner of the NDIA at the aggregator level and authorised by the NDIA to establish a live connection for registered providers who are seeking access to their data.

quickclaim's NDIS API package enables registered providers to access their own data, live and automated within your existing systems.

We have developed many enhancements on top of the NDIS Native API group which are also accessible to you.

Switching from NDIS Direct APIs to quickclaim NDIS Native API is easy and convenient. You don't need to change your code or logic, find out more information here.

quickclaim's other apps and APIs

quickclaim currently offers three applications for NDIS Providers and Participants:

quickclaim online: this is an online application for Providers to manage their NDIS budget and payments. This is our enterprise solution that connects to the majority of CRM and Finance systems to automate the NDIS claiming process.
qc.pay: is a Point-Of-Sales terminal connected to our payment gateway and quickclaim online app. This is a mobile application using QR Payment technology. As a Provider you can process NDIS claims instantly within this app. You can also check NDIS plans and service bookings of Participants by scanning their quickclaim card. More information at: https://quickclaim.io/qc-pay/
qc.card: is a mobile app for Participants. As a Participant you can secure your NDIS information behind a digital signature in a QR Code meaning that when you interact with your Providers and Planner you don't need to share your personal information. It also comes with a nice physical card with your QR signature. You can use your card to pay for services using your NDIS funds (currently only at registered providers and for agency and plan-managed budgets). There are many other features in the app like checking your plan and statements, giving (or revoking) consent to Providers to access your data or automatically process your invoices, or to communicate both ways with your Providers via notifications. More information at: https://quickclaim.io/qc-card/

To access quickclaim extra APIs for the above three apps, check this article: https://wiki.quickclaim.io/knowledge/using-quickclaim-api-suite-in-a-sandbox-with-mock-data

Available APIs under the ndis-native-api package

Service Bookings (4.0)(1 API included)
Service Bookings (3.0)(2 APIs included)
Payment Request (3.0)(1 API included)
Budget (3.0)(1 API included)
Interactions (3.0)(1 API included)
Reference Data (3.0)(2 APIs included)
Notifications (3.0)(1 API included)
Quotations (3.0)(1 API included)

How to get onboarded with the NDIS API?

Follow the below steps to create and activate your account:

Create an account on https://app.quickclaim.io
Connect your account to PRODA using this article: https://wiki.quickclaim.io/knowledge/connect-to-ndis-api
Navigate to https://app.quickclaim.io/app/integration
and write down your org-id and x-api-key from this page. You need these credentials in all the API calls for authentication.

Note: Your x-api-key never expires, it's recommended to re-issue the x-api-key every three months.

How to call the NDIS APIs?

First you need the base url. Add the below base url at beginning of all endpoints. The base url is:

https://api.quickclaim.io/ndis-native-api/

Second you need your credentials. All APIs have the same authentication method which is a pair of org-id and x-api-key. You should get your credentials within our app documented under the How to get onboarded with NDIS API section.

Please note that your credentials are global and are used across all the quickclaim apps and products.

You are going to use the pair of org-id and x-api-key in the headers of your calls.

Headers

Your credentials in the headers is always the same as below:

org-id: YOUR_ORG_ID
x-api-key: YOUR_X_API-KEY

Depending on the API call you may have other fields in the headers.

Note: For those who are using NDIS Direct API you can replace the (authorization, x-ibm-client-id) pair with (org-id, x-api-key).

Definition of the API calls

Definition of the API calls are documented on NDIS Developer Portal. They stay exactly the same for quickclaim NDIS Native API package.

Contact support@quickclaim.io if you need more information.

Switching from NDIS Direct API to quickclaim's NDIS API package

Quickclaim's NDIS Native APIs are exactly the same as NDIS APIs that you get directly from NDIS. The benefit of using quickclaim's NDIS Native APIs are:

We are providing your secure and complaint connection to the NDIS
We are acting as a cyber shield for you and maintaining the compatibility and change on your behalf
We manage your credentials and encrypted channel to PRODA so you don't need to do that. You can authenticate with NDIS APIs with a pair of org-id and x-api-key, we manage the rotation of your keys and tokens behind the scenes.
With the same credentials you can use all of our enhanced APIs including our mobile payment and digital card solutions.

How to switch to quickclaim?

Switching to quickclaim is easy:

Change the base url of your calls from:
https://NDIS-URL/.../ndis/ >> https://api.quickclaim.io/ndis-native-api/
Change your headers credentials from :
x-ibm-client-id >> org-id
authorization >> x-api-key
You should get your credentials within our app documented under the How to get onboarded with NDIS API section.
Use the exact NDIS endpoints with the same definitions (same query parameters, headers and body) to call the NDIS API. Include the version before the endpoint. So your URL is something like:
base-url + version + endpoint
ex. https://api.quickclaim.io/ndis-native-api/4.0/service-bookings/{service-booking-number}

NDIS Direct Call sample

var options = { 
  method: "GET", 
  url: "https://NDIS-URL/.../ndis/3.0/payments, 
  headers: 
  { 
    authorization: YOUR-NDIS-TOKEN,  
    x-ibm-client-id: YOUR-NDIS-ID,
    participant: 430000001
  }
};

The same call via quickclaim

var options = { 
  method: "GET", 
  url: "https://api.quickclaim.io/ndis-native-api/3.0/payments, 
  headers: 
  { 
    org-id: 1101,  
    x-api-key: "YOUR KEY",
    participant: 430000001
  }
};