Sandbox and Authentication
Set up Public API stage access, authenticate requests and understand how Native API access differs.
Testing and authentication differ between Public APIs and Native NDIS APIs.
- Public APIs can be tested in the quickclaim stage environment.
- Native NDIS APIs operate against the live NDIS environment because the NDIS does not provide a sandbox.
Available environments
| API type | Stage | Production |
|---|---|---|
| Public APIs | Available | Available |
| Native NDIS APIs | Not available | Available |
Public APIs are only available to quickclaim v1 organisations. Native NDIS APIs are available to quickclaim v1 and v2 organisations.
Public API stage access
Use the quickclaim stage environment to develop and test a Public API integration.
- Sign in at https://stage-app.quickclaim.io.
- Open the Integration page.
- Copy your stage organisation ID and API key.
- Use the Public API stage base URL:
https://stage-api.quickclaim.io/public/
- Add your stage credentials to each request.
- Use the test or mock data available in the stage environment.
Public API production access
After testing is complete:
- Sign in at https://app.quickclaim.io.
- Open the Integration page.
- Copy your production organisation ID and API key.
- Use the Public API production base URL:
https://api.quickclaim.io/public/
Stage and production credentials are different. Use credentials from the same environment that you are calling.
Public API authentication
Add your organisation ID and API key to the request headers:
org-id: YOUR_ORGANISATION_ID x-api-key: YOUR_API_KEY
Example request structure:
curl --request GET \ --url "PUBLIC_API_BASE_URL/ENDPOINT" \ --header "org-id: YOUR_ORGANISATION_ID" \ --header "x-api-key: YOUR_API_KEY"
Replace the base URL, endpoint and credentials with the appropriate values for your environment.
For available endpoints, request fields and response examples, see the quickclaim Public API documentation.
Native NDIS API access
The NDIS does not provide a stage or sandbox environment for Native API testing.
Native API requests interact with live NDIS services and may access or change live information. Supported operations can include submitting NDIS claims.
Before using the Native APIs:
- Complete the required production onboarding.
- Confirm that your organisation’s NDIS connection is active.
- Confirm the required participant and provider permissions.
- Obtain your production access details from quickclaim.
- Review the endpoint requirements before making a request.
- Carefully review any request that creates or changes NDIS data.
Native API base URLs, authentication requirements, headers and endpoint definitions are available in the restricted Native API Reference.
We recommend arranging a technical meeting with quickclaim before beginning a new Native API integration, particularly for claim submission or another operation that changes live NDIS data.
Protect your credentials
- Store API keys in a secure secret store or environment variable.
- Never expose credentials in browser code or mobile applications.
- Never commit credentials to a source-code repository.
- Do not include credentials in screenshots, emails or application logs.
- Restrict credentials to authorised developers and systems.
- Do not share production credentials with third parties.
Next steps
- Use the Public API Reference for Public API access and the Postman documentation link.
- Use the restricted Native API Reference for Native API authentication and endpoint details.
- Review Errors and Limits before moving your integration to production.
Contact support@quickclaim.io if you need stage access, production onboarding assistance or help with a Native API workflow.