Fetching (part) of the data for a single policy, a range, or a list of all policies.
Once a policy has been submitted, the data is available through the retrieve function. The variant is used to determine the scope of the required information.
The three standard retrieval options are available, and
policy also has two additional variants with a specific purpose. These variants are available to retrieve the policy details of a policy after renewal or a mid-term change, and include the financial information like premium for billing or restitution as a result of the change to the policy.
|1||single||Obtain full details of a single policy based on the unique policy reference.|
|2||status||Obtain status information of a single policy by policy reference.|
|3||range||Obtain details of multiple policies based on a range of unique policy references.|
|4||list||Obtain references of all policies available within the authorization restrictions.|
|5||renewal||Policy information and corresponding journal entry for a policy after renewal to update the agent administration.|
|6||midTerm||Policy information and corresponding journal entry for a policy after renewal to update the agent administration.|
Technical specifications: retrievePolicy
retrievePolicy function is a webservice call without a body. The
functionVariant and the (range of)
contractNumber are included in the query parameters in the request header.
For more information see the Retrieve functions section of the Design principles chapter.
The output will contain a single
policyStructure when only one id is specified, or an array of policy structures when more than one id is specified, or none at all. See the policy structure section for more information on the
A validated policy dataset will always contain at least two
parties, of the entityType
policyHolder. Property insurance has at least one
object and other business lines like life and health insurance an additional
party with the entityType
insuredPerson will be present. For any business line at least one
coverage is expected.
For the function variants
mid-term all the aforementioned entity types are required, together with a
financialTransaction entity which holds the premium components which resulted from the policy change or renewal.
|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.|
|businessline||all||ADNBRA||Classification of the type of contract. E.g. to be used for addressing within a company.|
|porCompany||all||PORMAA||The identification of the insurer is necessary to find the correct product and rate combination.|
|afdDefinitionName||all||string||Name of the AFD-definition.|
|afdDefinitionVersion||all||string||Version of the AFD-definition.|
|contractNumber||4||date||Number of the policy attributed by the insurance provider.|
|effectiveDate||6||date||Date on which the data of this entity takes/took effect.|
|renewalDate||5||date||Date on which the current term expires and the new term starts.|
|paymentTermInMonths||integer||The payment term of the premium amount; monthly, bimonthly, quarterly, semesterly.|
|status||2||integer||Indication of the current status.|
|object||Object with any
|coverage||Coverage with any
|party||Party with any
|…||Any additional attributes within the
If no policies are found based on the query, a ‘No Content’ (HTTP 204) response will be returned.
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.