Claim and Query Claim Status

claims/claimnumber

GET

GET claims/summary/{claimnumber}

Description

This API allows for a provider to query the submission status for a claim by specifying a claim number.

Returns results limited to the organisation that submitted the claims.

Results include:

  • claim ID, the unique identifier for this submitted claim
  • claim number, the ACC45 number
  • the date the claim request was submitted
  • the submission status, that is Failed or Receipted
  • patient’s first name and family name
  • the names of the facility and the treatment provider.

To learn more about the overall API process check out Get ConnectedLearn More and our Release Notes.

 Other API Query related solutions you may find of interest can be found in Potential Query API Solutions and Query APIs – Detail that may assist.

Resource Summary

Security

Type

application/json

Category

Query Claims

URL

https://provider.api-compliance.acc.co.nz/api/v2/claims/summary/{claimNumber}

Supporting Documentation

Request Body

claimNumber claimNumber null true

Operations

When using the API Key custom token in the Operations portion for any selected API below, set NAME to 'apikey', VALUE to My Apps, Consumer Key value, and select the HEADER option before clicking SET.

Basic HTTP authentication

Set

OAuth 2 authentication

Set

API Key custom token

Set

Working...

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 200

    Ok

  • 400

    Bad Request: invalid data

  • 401

    Unauthorized: authentication error

  • 403

    Forbidden: authorization error

  • 404

    Not Found

  • 500

    Internal Server Error