How do I get started with quickclaim APIs?
Compare quickclaim Public and Native NDIS APIs and select the right integration option for your quickclaim version.
quickclaim provides two API options:
- Public APIs primarily provide access to data stored and maintained in quickclaim.
- Native NDIS APIs send supported requests directly to the NDIS.
The APIs available to your organisation depend on your quickclaim version.
API availability
| API type | quickclaim v1 | quickclaim v2 |
|---|---|---|
| Public APIs | Available | Not available |
| Native NDIS APIs | Available | Available |
Important: Organisations using quickclaim v2 must use the Native NDIS APIs. Public APIs are only available with quickclaim v1.
If you do not know which version your organisation uses, ask your quickclaim administrator or contact quickclaim Support.
Compare the APIs
| Feature | Public APIs | Native NDIS APIs |
| Availability | quickclaim v1 only | quickclaim v1 and v2 |
| Data source | Primarily stored quickclaim data | Live NDIS data |
| Data management | quickclaim manages NDIS calls and background jobs | Your system initiates each NDIS operation |
| Data freshness | Depends on the endpoint and refresh schedule | Retrieved when the request is made |
| Submit NDIS claims | Not supported | Supported |
| API structure | Simplified quickclaim structure | Supported NDIA API structure |
| NDIS knowledge required | Lower | Higher |
| Testing | quickclaim stage environment | Live NDIS environment only |
Public APIs
Public APIs are best suited to integrations that need to retrieve data maintained in quickclaim.
quickclaim manages the underlying NDIS calls and background synchronisation jobs. Most responses therefore contain stored data and may not represent the live NDIS response at that exact moment.
Choose the Public APIs if:
- Your organisation uses quickclaim v1.
- You primarily need to retrieve data stored in quickclaim.
- You do not need to submit NDIS claims.
- You prefer a simplified integration.
- You want quickclaim to manage the underlying NDIS calls and background processes.
For endpoint definitions, request examples and response schemas, see the quickclaim Public API documentation.
Native NDIS APIs
Native NDIS APIs send supported operations directly to the NDIS. They can retrieve live information and perform supported actions, including submitting NDIS claims.
Choose the Native NDIS APIs if:
- You need to submit NDIS claims.
- You need to retrieve live NDIS information.
- Your integration follows NDIA API structures.
- You need greater control over NDIS requests and workflows.
Native APIs require developers to understand NDIA request structures, permissions, plan types, API versions, validation rules, rate limits and rejection responses.
The complete Native API specifications are available in the restricted Native API Reference article.
Next steps
- Read Sandbox and Authentication to understand environments and credentials.
- Use the Public API Reference if you are integrating with the quickclaim v1 Public APIs.
- Use the restricted Native API Reference if you are integrating with the Native NDIS APIs.
- Review Budget APIs for stored budget and live PACE Budget options.
- Review Errors and Limits before moving to production.
Contact support@quickclaim.io to arrange a technical meeting if you need help choosing an API, confirming supported features or planning your integration.