Function: retrieveClaim

Fetching (part) of the data for a single policy, a range, or a list of all policies.

Usage: retrieveClaim

Retrieving a single claim can be used as an input for a step in the claim handling process, or to provide the current claim information to a portal or account page of the broker or policy holder. Retrieving a range of policies could be an input for a small bulk process of a broker or an insurance provider. The list variant can also be used with a different Select parameter to indicate which attributes of the claim should be returned in the response. This output can for instance be used to create management ‘dashboard’ information for a broker.

# Variant Description
1 single Obtain full details of a single claim based on the unique claim reference.
2 status Obtain status information of a single claim by claim reference.
3 range Obtain details of multiple claims based on a range of unique claim references.
4 list Obtain reference information of all claims available within the authorization restrictions.

Technical specifications: retrieveClaim

Input: retrieveClaim

The retrieve function is a webservice call without a body. The functionVariant and the (range of) claimNumber are included in the query parameters in the request header.
For more information see the Retrieve functions section of the Design principles chapter.

Output: retrieveClaim

The output will contain a single claim structure when only one id is specified, or an array of claim structures when more than one id is specified, or none at all. See the claim structure section for more information.
If no claims are found based on the query, a ‘No Content’ (HTTP 204) response will be returned.

Name Variant Type Description
commonFunctional Entity for general information with regard to structure, handling and processing.
entityType all string Set to ‘default’.
dataCatalogVersion all ADNAFM Version of the data catalog on which the message is based.
functionVariant all APIVAR The function variant is used to determine the additional set of required and optional input and output data.
claim The claim entity is used for grouping claim-related data. A claim is a request made by the insured for insurer remittance of payment due to loss incurred, and covered under the policy agreement.
claimNumberCompany all string The identifying number of the claim with the company / underwriting agent. This number is linked to the claim file and (usually) does not change.
entityType all string Set to ‘default’.
status 2 string Status.
Any additional attributes within the claimStructure.


When a negative response is generated, it follows the general rules as described in the Error section of the Status codes and error handling chapter.

Click below to see the Open Api Specification (3.0.0)


Thanks for your feedback.

Post your comment on this topic.

Post Comment