Function: submitOffer

Submit a request for an offer to the insurance provider.

Usage: submitOffer

The data to make up an offer can be based on input from the application process, but it can also be based on data from an existing policy. For instance when a company considers an additional coverage for an existing property insurance. The functionVariant parameter indicates the type of offer and allows differentiation of (required) parameters, for instance the reference to an existing policy on which the offer is based.

The actual offer in PDF (or other) format may be included in the response (see the policyStructure section for more details).

# Variant Description
1 new Generally the default variant for offers made to potential and existing customers
2 basedOnPolicy Available for customers who consider changing an existing policy.

Technical specifications: submitOffer

Input: submitOffer

Name Variant Type Description
policyStructure
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.
policy With entityType policyDetails.
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.
externalIndicative 1 string The identifying characteristic that an intermediary assigns. Can also be used as a temporary contract number.
contractNumber 2 string The identifying characteristic that a company (or underwriting agent) assigns to the policy.
effectiveDate all date Date on which the data of this entity takes/took effect.
party 1 The party entity with entityType policyHolder.
coverage all The coverage entity is intended for grouping coverage-related data. A coverage is the protection provided by the policy against a certain risk. 
Any additional attributes within the policyStructure.

Output: submitOffer

There are three basic types of output which are described in the Output section of the Design principles chapter.

A positive response for the submitOffer function may contain a dataset. The minimal result is a reference to the transaction with the number, the expiry date and the offer amount plus possible taxes and costs.
In order to simplify processing it is advised that the input data is returned in the output for reference. Any additional information that was collected during the transaction may also be added to the output for reference.

Name Variant Type Description
policyStructure
commonFunctional Entity for general information with regard to structure, handling and processing.
entityType all string Set to ‘default’.
dataCatalogVersion ADNAFM string 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.
policy With entityType policyDetails.
businessLine all ADNBRA Classification of the type of contract. E.g. to be used for addressing within an 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.
externalIndicative 1 string The identifying characteristic that an intermediary assigns. Can also be used as a temporary contract number.
contractNumber 2 string The identifying characteristic that a company (or underwriting agent) assigns to the policy.
offerNumber all* string This standardized code indicates: the type of coverage and the risks against which the coverage has been / will be taken out.
referralNumber all* string The number assigned to refer. The insurer / underwriting agent can determine which attribute is used for this.
status 2 integer Indication of the current status.
offerExpiryDate all* date End date (up to and including date) of the validity of the offer.
party 1 The party entity with entityType policyHolder.
coverage The coverage entity is intended for grouping coverage-related data. A coverage is the protection provided by the policy against a certain risk. 
grossPremiumInstallment all decimal Gross premium installment.
Any additional attributes within the policyStructure.
  • One of offerNumber and referralNumber is required.
    If the request can be processed immediately (straight through processing), the offerNumber and offerExpiryDate is required.
    When the request is redirected to an internal workflow, for instance for manual underwriting, the referralNumber is required to enable the client application to inquire after the status.

Errors

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)

Feedback

Thanks for your feedback.

Post your comment on this topic.

Post Comment