Claim and Query Claim Status

claims/claimid/status

GET

claims/claimid/status

Description

One of a series of APIs that allows software vendors to give the ability for the Provider to see whether a claim has been accepted & what are the latest diagnoses if other Providers have been referred to.

This specific API returns the registration status for a specific claim submitted by the organisation sending the query.

Relevant status values are ‘Receipted’ and ‘Failed’.

Resource Summary

Security

Type

application/json

URL

https://provider.api-compliance.acc.co.nz/api/v2/claims/status

Supporting Documentation

Query Parameters


Name Values Description
claimNumber
(required)

claimNumber

vendorId
(required)

vendorId

providerId
(required)

providerId


Request Body

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
  • 400

    Bad Request: invalid data

  • 401

    Unauthorized: authentication error

  • 403

    Forbidden: authorization error

  • 404

    Not Found

  • 500

    Internal Server Error