Skip to content
More support Support portal
Contact us
  • There are no suggestions because the search field is empty.

Native API Reference

Access the restricted Native NDIS API specifications and learn how URLs and authentication differ between quickclaim v1 and v2.

Restricted documentation: This article and its specification files are for authorised quickclaim customers only. Do not share or redistribute them outside your organisation.

Native NDIS APIs allow your system to send supported requests directly to the live NDIS environment through quickclaim.

Native APIs are available to organisations using quickclaim v1 and quickclaim v2, but the base URL and authentication method are different.

Compare v1 and v2
Setting quickclaim v1 quickclaim v2
Environment Live NDIS only Live NDIS only
Base URL https://api.quickclaim.io/ndis-native-api/ https://api.quickclaim.io/ndis-native-api/v2/
Authentication org-id and x-api-key headers org-id and Authorization headers

The NDIS does not provide a stage or sandbox environment for Native APIs. Every request may access or change live NDIS information.

quickclaim v1 authentication

Use the following base URL:

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

Include your organisation ID and API key as separate headers:

org-id: YOUR_ORGANISATION_ID x-api-key: YOUR_API_KEY

Example request structure:

curl --request GET \   --url "https://api.quickclaim.io/ndis-native-api/{version}/{endpoint}" \   --header "org-id: YOUR_ORGANISATION_ID" \   --header "x-api-key: YOUR_API_KEY"

Obtain your v1 production credentials from the Integration page in quickclaim.

quickclaim v2 authentication

Use the following base URL:

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

For v2, send the API secret in the Authorization header:

Authorization: x-api-key YOUR_SECRET org-id: YOUR_ORGANISATION_ID

Example request structure:

curl --request GET \   --url "https://api.quickclaim.io/ndis-native-api/v2/{version}/{endpoint}" \ --header "org-id: YOUR_ORGANISATION_ID" \  --header "Authorization: x-api-key YOUR_SECRET"

Replace YOUR_SECRET with the secret supplied for your v2 integration.

Do not use the v1 org-id and x-api-key header format for a v2 request.

Additional request requirements

The authentication headers above identify your quickclaim integration. Individual NDIS endpoints may require additional NDIA-defined headers, path parameters, query parameters or request fields.

Always use the request definition in the relevant YAML specification.

Download API specifications
API Version Download
Plans 4.0 Download YAML
Participant Plan Type 4.0 Download YAML
PACE Budget 5.0 Download YAML
PACE Historical 4.0 Download YAML
Non-PACE Budget 4.0 Download YAML
Service Bookings 4.0 Download YAML
Notifications 3.0 Download YAML
Payments 4.0 Download YAML
Quotations 3.0 Download YAML
Products 3.0 Download YAML
Reference Data 3.0 Download YAML
Upload File 3.0 Download YAML

PACE Budget requests must use version 5.0.

Before publishing, confirm that each YAML file has the same restricted access controls as this article.

Before making a request
  1. Confirm whether your organisation uses quickclaim v1 or v2.
  2. Use the base URL and authentication method for that version.
  3. Confirm that your organisation’s NDIS connection is active.
  4. Confirm the required participant and provider authority.
  5. Download and review the applicable YAML specification.
  6. Confirm the API version and endpoint path.
  7. Validate every required header, parameter and request field.
  8. Review the effect of the request on live NDIS data.
Live-operation warning

Native operations may retrieve, create or change live NDIS information. Supported operations can include submitting NDIS claims.

Before sending a data-changing request:

  • Use verified participant and provider information.
  • Prevent accidental duplicate submissions.
  • Retain request references required for reconciliation.
  • Review the response before retrying a failed request.
  • Do not automatically retry unless you have confirmed that the original request was not processed.
Related documentation
  • Review Sandbox and Authentication for environment guidance.
  • Review Budget APIs for Public and Native budget options.
  • Review Errors and Limits for rate limits, retries and HTTP errors.
  • Review NDIS Rejection Codes for claiming rejection responses.
  • Review API Version Updates before changing versions.

Contact support@quickclaim.io to confirm access, obtain v2 credentials or discuss a Native API workflow.