5.4.1. New

The operation new in case of a contract will add a new policy, loan, pension, master agreement or contract within an existing master agreement). The payload consists of the structures needed in the particular situation, so it can be a policyStructure, a loanStructure, a pensionStructure or a masterAgreementStructure (see also policyStructure, loanStructure, pensionStructure and masterAgreementStructure).

*The functions, variants and structures concerning pension and loan are under construction and will follow in due time.

How to use variants

If you want to add a new contract (for example a policy), choose the operation new. If a particular handling variant is requested, select a variant. If not, select the default variant. The variant determines which attributes are mandatory.

A positive response to the operation new contains the AFD structure of the request as reference, with the result of the transaction (process.statusType).The requested information that was collected during the transaction, is also added to the output.

Different scenarios are possible, for example:

• If there is no immediate result available (because of manual processing), then the status is in process (in behandeling). In this case a referralNumber is required.
• If the application is not accepted, then the status is rejected (afgewezen).
• If the application is accepted, then a complete return message (input message completed with result data) is returned.
  

If a negative response is generated, that means the request is technically incorrect, it follows the general rules as described in the Error section of the HTTP status codes and error handling chapter.

Variants

The variant enables a differentiation in requirements to suit the specific situations (listed below), and for each variant, to which AFD structure it applies.

U/C: Under construction.

<default> – Application for a contract to be underwritten and processed

The default variant is the most common variant and is used to add a new contract or contracts.

policyStructure

The policyStructure is used to add a new policy. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/policies/new	policyStructure	N/A	policyStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
policy	externalIndicative	I	Identifying mark assigned by the agent. Can also be used as a temporary contract number.
policy	contractNumber	O	If the request can be processed immediately (straight through processing), the contractNumber is required. If the request is redirected to an internal workflow, for instance for manual underwriting, the referralNumber is required in order to enable the client application to inquire about the status.
policy	referralNumber	O	The assigned reference number. The insurer / underwriting agent can determine the attribute to be used. See also contractNumber
policy	effectiveDate	I/O	Date on which the data of this entity takes/took effect.
party		I/O	With entityType policyHolder.
coverage	coverageCode	I/O	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to add a new masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

If the complete masterAgreement is new (including the underlying contracts), no path parameter is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/new	masterAgreementStructure	N/A	masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within that masterAgreement, a path parameter ({masterAgreementId}) is added to the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/{masterAgreementId}/new	masterAgreementStructure	N/A	masterAgreementStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
masterAgreement	externalIndicative	I**	Identifying mark assigned by the agent. Can also be used as a temporary contract number. Please note: only applicable with a new masterAgreement.
masterAgreement	contractNumber	I/O**	If the request is for a new masterAgreement and can be processed immediately (straight through processing), the contractNumber is required. If the request is redirected to an internal workflow, the referralNumber is required, in order to enable the client application to inquire after the status.Please note: mandatory input only with new particular contract, mandatory output only with new masterAgreement.
masterAgreement	referralNumber	O**	The assigned reference number. The insurer / underwriting agent can determine the attribute to be used. See also contractNumber. Please note: only applicable with a new masterAgreement.
masterAgreement	effectiveDate	I/O**	Date on which the data of this entity takes/took effect. Please note: only applicable with a new masterAgreement.
policy	externalIndicative	I**	Identifying mark assigned by the agent. Can also be used as a temporary contract number. Please note: only applicable with new particular contract.
policy	contractNumber	O**	If the request for particular contract can be processed immediately (straight through processing), the contractNumber is required. If the request is redirected to an internal workflow the referralNumber is required, in order to enable the client application to inquire after the status. Please note: only applicable with a new particular contract.
policy	referralNumber	O**	The number assigned to refer. The insurer / underwriting agent can determine which attribute is used for this. See also contractNumber. Please note: only applicable with new particular contract.
policy	effectiveDate	I/O**	Date on which the data of this entity takes/took effect. Please note: only applicable with a new particular contract.
party		I/O	With entityType policyHolder.
coverage	coverageCode	I/O**	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out. Please note: only applicable with a new particular contract.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

basedOnOffer – Conversion of an offer into a contract

If an offer (for a contract) is converted into a contract, the variant basedOnOffer is used. The offerNumber refers to the offer, which contains the details for the contract.

policyStructure

The policyStructure is used to convert an offer into a new policy. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/policies/offers/{offerId}/based-on-offer	policyStructure	N/A	policyStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
policy	offerNumber	I	Number of the offer.
policy	externalIndicative	I	Identifying mark assigned by the agent. Can also be used as a temporary contract number.
policy	contractNumber	I/O	If the request can be processed immediately (straight through processing), the contractNumber is required. If the request is redirected to an internal workflow, for instance for manual underwriting, the referralNumber is required in order to enable the client application to inquire about the status.
policy	referralNumber	O	The assigned reference number. The insurer / underwriting agent can determine the attribute to be used. See also contractNumber
policy	effectiveDate	I/O	Date on which the data of this entity takes/took effect.
party		I/O	With entityType policyHolder.
coverage	coverageCode	I/O	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to convert an offer into a masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

If the complete masterAgreement (including the underlying contracts) is subject to this operation and variant, one path parameter ({offerId}) is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/offers/{offerId}/based-on-offer	masterAgreementStructure	N/A	masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within that masterAgreement, two path parameters ({masterAgreementId} and {offerId}) are included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/{masterAgreementId}/offers/{offerId}/based-on-offer	masterAgreementStructure	N/A	masterAgreementStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
masterAgreement	offerNumber	I**	Number of the offer. Please note: only applicable with a new masterAgreement.
masterAgreement	externalIndicative	I**	Identifying mark assigned by the agent. Can also be used as a temporary contract number. Please note: only applicable with a new masterAgreement.
masterAgreement	contractNumber	I/O**	If the request is for a new masterAgreement and can be processed immediately (straight through processing), the contractNumber is required. If the request is redirected to an internal workflow, the referralNumber is required, in order to enable the client application to inquire after the status.Please note: mandatory input only with new particular contract, mandatory output only with new masterAgreement.
masterAgreement	referralNumber	O**	The assigned reference number. The insurer / underwriting agent can determine the attribute to be used. See also contractNumber. Please note: only applicable with a new masterAgreement.
masterAgreement	effectiveDate	I/O**	Date on which the data of this entity takes/took effect. Please note: only applicable with a new masterAgreement.
policy	offerNumber	I**	Number of the offer. Please note: only applicable with new particular contract.
policy	externalIndicative	I**	Identifying mark assigned by the agent. Can also be used as a temporary contract number. Please note: only applicable with new particular contract.
policy	contractNumber	O**	If the request for particular contract can be processed immediately (straight through processing), the contractNumber is required. If the request is redirected to an internal workflow the referralNumber is required, in order to enable the client application to inquire after the status. Please note: only applicable with a new particular contract.
policy	referralNumber	O**	The number assigned to refer. The insurer / underwriting agent can determine which attribute is used for this. See also contractNumber. Please note: only applicable with new particular contract.
policy	effectiveDate	I/O**	Date on which the data of this entity takes/took effect. Please note: only applicable with a new particular contract.
party		I/O	With entityType policyHolder.
coverage	coverageCode	I/O**	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out. Please note: only applicable with a new particular contract.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

notification – Notification of contract details to third parties who provide supporting services

If contract information needs to be sent to third parties who provide supporting services, the variant notification is used. Examples of third parties are car or glass repair, salvage, repatriation and medical aid.

policyStructure

The policyStructure is used to send notifications to third parties in case of a policy. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/policies/notification	policyStructure	N/A	policyStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
policy	contractNumber	I/O	Number of the contract.
policy	effectiveDate	I	Date on which the data of this entity takes/took effect.
party		I	With entityType policyHolder.
party		I	With a third party entityType like appraiser, damageRepair.
coverage	coverageCode	I	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementsStructure is used to send notifications to third parties in case of a masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

If the complete masterAgreement (including the underlying contracts) is subject to this operation and variant, no path parameter is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/notification	masterAgreementStructure	N/A	masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within that masterAgreement, a path parameter ({masterAgreementId}) is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/{masterAgreementId}/notification	masterAgreementStructure	N/A	masterAgreementStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
masterAgreement	contractNumber	I/O	Unique identification of an entity.
policy	contractNumber	I/O	Number of the contract.
policy	effectiveDate	I	Date on which the data of this entity takes/took effect.
party		I	With entityType policyHolder.
party		I	With a third party entityType like appraiser, damageRepair.
coverage	coverageCode	I	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

offer – Offer for a contract

If an offer (proposal for a contract) is requested, the variant offer is used.

policyStructure

The policyStructure is used to create an offer for a policy. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/policies/offer	policyStructure	N/A	policyStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
policy	externalIndicative	I/O	Identifying mark assigned by the agent. Can also be used as a temporary contract number.
policy	offerNumber	O	If the request can be processed immediately (straight through processing),the offerNumber is required.
policy	referralNumber	O
policy	offerExpiryDate	O	If the request can be processed immediately (straight through processing),the offerExpiryDate is required.
policy	effectiveDate	I/O	Date on which the data of this entity takes/took effect.
party		I/O	With entityType policyHolder.
coverage	coverageCode	I/O	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out.
coverage	grossPremiumInstallment	O	Gross premium amount related to premium payment term in months.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to create an offer for a masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

If the complete masterAgreement (including the underlying contracts) is subject to this operation and variant, no path parameter is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/offer	masterAgreementStructure	N/A	masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but only a particular contract within that masterAgreement, a path parameter ({masterAgreementId}) is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/{masterAgreementId}/new/offer	masterAgreementStructure	N/A	masterAgreementStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
masterAgreement	externalIndicative	I**	Identifying mark assigned by the agent. Can also be used as a temporary contract number. Please note: only applicable with a new masterAgreement.
masterAgreement	offerNumber	O**	Number of the offer. Please note: only applicable with a new masterAgreement.
masterAgreement	referralNumber	O**	The assigned reference number. The insurer / underwriting agent can determine the attribute to be used. See also contractNumber. Please note: only applicable with a new masterAgreement.
masterAgreement	effectiveDate	I/O**	Date on which the data of this entity takes/took effect. Please note: only applicable with a new masterAgreement.
masterAgreement	offerExpiryDate	O**	Once the request can be processed, the offerExpiryDate is required. Please note: only applicable with a new masterAgreement.
policy	externalIndicative	I**	Identifying mark assigned by the agent. Can also be used as a temporary contract number. Please note: only applicable with new particular contract.
policy	offerNumber	O**	If the request for particular contract can be processed immediately (straight through processing), the offerNumber is required. If the request is redirected to an internal workflow the referralNumber is required, in order to enable the client application to inquire after the status. Please note: only applicable with a new particular contract.
policy	referralNumber	O**	The number assigned to refer. The insurer / underwriting agent can determine which attribute is used for this. See also offerNumber. Please note: only applicable with new particular contract.
policy	effectiveDate	I/O**	Date on which the data of this entity takes/took effect. Please note: only applicable with a new particular contract.
policy	offerExpiryDate	O**	Once the request can be processed, the offerExpiryDate is required. Please note: only applicable with a new particular contract.
party		I/O	With entityType policyHolder.
coverage	coverageCode	I/O**	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out. Please note: only applicable with a new particular contract.
coverage	grossPremiumInstallment	O**	Gross premium amount related to premium payment term in months. Please note: only applicable with request of a new rate of particular contract.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

offerOncontract – Offer for a change of a contract

If an offer (for a change of a contract) is requested, based on an already existing contract, the variant offerOnContract is used.

policyStructure

The policyStructure is used to request an offer for a policy, based on an existing contract. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/policies/{policyId}/offer-on-contract	policyStructure	N/A	policyStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
policy	contractNumber	I/O	Number of the contract.
policy	offerNumber	O	If the request can be processed immediately (straight through processing),the offerNumber is required.
policy	referralNumber	O	If the request is redirected to an internal workflow, for instance for manual underwriting,the referralNumber is required in order to to enable the client application to inquire about the status.
policy	offerExpiryDate	O	If the request can be processed immediately (straight through processing),the offerExpiryDate is required.
policy	effectiveDate	I/O	Date on which the data of this entity takes/took effect.
party		I/O	With entityType policyHolder.
coverage	coverageCode	I/O	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out.
coverage	grossPremiumInstallment	O	Gross premium amount related to monthly installment.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to request an offer (based on an existing contract) for a masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

If the complete masterAgreement (including the underlying contracts) is subject to this operation and variant, one path parameter ({masterAgreementId}) is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/{masterAgreementId}/offer-on-contract	masterAgreementStructure	N/A	masterAgreementStructure

If not the complete masterAgreement is subject to this operation but only a particular contract within that masterAgreement, two path parameters ({masterAgreementId} and {contractId}) are included in the endpoint. This is shown in the table below. Note: in real life endpoints you should use policies, loans or pensions and their respective Ids ({policyId}, {loanId} or {pensionId}) instead of contracts (and {contractId}).

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/{masterAgreementId}/contracts/{contractId}/offer-on-contract	masterAgreementStructure	N/A	masterAgreementStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
masterAgreement	contractNumber	I/O	Number of the masterAgreement contract.
masterAgreement	offerNumber	O**	Number of the offer. Please note: only applicable with a new masterAgreement.
masterAgreement	referralNumber	O**	The assigned reference number. The insurer / underwriting agent can determine the attribute to be used. See also contractNumber. Please note: only applicable with a new masterAgreement.
masterAgreement	effectiveDate	I/O**	Date on which the data of this entity takes/took effect. Please note: only applicable with a new masterAgreement.
masterAgreement	offerExpiryDate	O**	Once the request can be processed, the offerExpiryDate is required. Please note: only applicable with a new masterAgreement.
policy	contractNumber	I/O**	Number of the contract. Please note: only applicable with a new particular contract.
policy	offerNumber	O**	If the request for particular contract can be processed immediately (straight through processing), the offerNumber is required. If the request is redirected to an internal workflow the referralNumber is required, in order to enable the client application to inquire after the status. Please note: only applicable with a new particular contract.
policy	referralNumber	O**	The number assigned to refer. The insurer / underwriting agent can determine which attribute is used for this. See also offerNumber. Please note: only applicable with new particular contract.
policy	effectiveDate	I/O**	Date on which the data of this entity takes/took effect. Please note: only applicable with a new particular contract.
policy	offerExpiryDate	O**	Once the request can be processed, the offerExpiryDate is required. Please note: only applicable with a new particular contract.
party		I/O	With entityType policyHolder.
coverage	coverageCode	I/O**	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out. Please note: only applicable with a new particular contract.
coverage	grossPremiumInstallment	O**	Gross premium amount related to premium payment term in months. Please note: only applicable with request of a new rate of particular contract.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

rate – Calculate rate for a contract

If the calculation of a rate is requested for a new contract, the variant rate is used.

policyStructure

The policyStructure is used to request a calculation of a rate for a new policy. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/policies/rates/application	policyStructure	N/A	policyStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
policy	effectiveDate	I	Date on which the data of this entity takes/took effect.
coverage	coverageCode	I/O	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out.
coverage	grossPremiumInstallment	O	Gross premium amount related to premium payment term in months.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to request a calculation of a rate for a masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/rates/application	masterAgreementStructure	N/A	masterAgreementStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
masterAgreement	contractNumber	I**	Number of the masterAgreement contract. Please note: only applicable with request of a new rate of a particular contract.
masterAgreement	effectiveDate	I/O**	Date on which the data of this entity takes/took effect. Please note: only applicable with a new rate of masterAgreement.
policy	effectiveDate	I/O**	Date on which the data of this entity takes/took effect. Please note: only applicable with request of a new rate of particular contract.
coverage	coverageCode	I/O**	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out. Please note: only applicable with request of a new rate of particular contract.
coverage	grossPremiumInstallment	O**	Gross premium amount related to premium payment term in months. Please note: only applicable with request of a new rate of particular contract.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

rateOffer – Calculate rate for an offer for a contract

The variant rateOffer is used to calculate the rate in case of an offer for a contract. So this variant is more specific than the variant offer.

policyStructure

The policyStructure is used to request a calculation of a rate for an offer for a policy. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/policies/rates/offer	policyStructure	N/A	policyStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
coverage	coverageCode	I/O	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out.
coverage	grossPremiumInstallment	O	Gross premium amount related to monthly installment.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to request a calculation of a rate for an offer for a masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/rates/offer	masterAgreementStructure	N/A	masterAgreementStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
masterAgreement	contractNumber	I**	Number of the masterAgreement contract. Please note: only applicable with request of a new rate of particular contract.
coverage	coverageCode	I/O**	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out. Please note: only applicable with request of a new rate of particular contract.
coverage	grossPremiumInstallment	O**	Gross premium amount related to premium payment term in months. Please note: only applicable with request of a new rate of particular contract.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

rateOfferQuick – Calculate rate for an offer for a contract based on limited input

The variant rateOfferQuick is used to make a quick calculation of a rate in case of an offer for a contract, based on limited client specific input and some default/average settings.

policyStructure

The policyStructure is used to request a quick calculation of a rate for an offer for a policy. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/policies/rates/offer-quick	policyStructure	N/A	policyStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
coverage	coverageCode	I/O	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out.
coverage	grossPremiumInstallment	O	Gross premium amount related to monthly installment.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to request a quick calculation of a rate for an offer for a masterAgreement. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/rates/offer-quick	masterAgreementStructure	N/A	masterAgreementStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
masterAgreement	contractNumber	I**	Number of the masterAgreement contract. Please note: only applicable with request of a new rate of particular contract.
coverage	coverageCode	I/O	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out.
coverage	grossPremiumInstallment	O	Gross premium amount related to premium payment term in months.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.

registration – Registration of a new contract already underwritten

The variant registration is used to add a new contract in case of automatic underwriting.

policyStructure

The policyStructure is used to add a new policy, in case of automatic underwriting (usually only for relatively simple risk products). The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/policies/registration	policyStructure	N/A	policyStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the process (codelist ADNSTS) within the entityType transaction.
policy	externalIndicative	I	Identifying mark assigned by the agent. Can also be used as a temporary contract number.
policy	contractNumber	O	Number of the contract.
policy	effectiveDate	I/O	Date on which the data of this entity takes/took effect.
party		I/O	With entityType policyHolder.
coverage	coverageCode	I/O	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.

masterAgreementStructure

The masterAgreementStructure is used to add a masterAgreement, in case of automatic underwriting. The mandatory attributes (in a generic way) are listed in the table Mandatory input and/or output (I/O) attributes.

Endpoint definition

If the complete masterAgreement (including the underlying contracts) is subject to this operation and variant, no path parameter is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/registration	masterAgreementStructure	N/A	masterAgreementStructure

If not the complete masterAgreement is subject to this operation and variant, but the registration only applies to a particular contract within the masterAgreement, a path parameter ({masterAgreementId}) is included in the endpoint. This is shown in the table below.

Method	Endpoint	Request	Query parameter(s)	Response	Remarks
POST	{ uri }/master-agreements/{masterAgreementId}/new/registration	masterAgreementStructure	N/A	masterAgreementStructure

Mandatory input and/or output (I/O) attributes

Entity	Attribute	I/O	Remarks
commonFunctional	dataCatalogVersion	I/O	Version of the data catalog on which the message is based.
commonFunctional	functionVariant	I/O	The function variant is used to determine the additional set of required and optional input and output data.
commonFunctional	businessLine	I/O	Classification of the type of contract. E.g. to be used for addressing within a company.
commonFunctional	porCompany	I/O	The identification of the insurer is necessary to find the correct product and rate combination.
commonFunctional	afdDefinitionName	I/O	Name of the AFD-definition.
commonFunctional	afdDefinitionVersion	I/O	Version of the AFD-definition.
process	statusType	O	The status of the proces (codelist ADNSTS) within the entityType transaction.
masterAgreement	externalIndicative	I**	Identifying mark assigned by the agent. Can also be used as a temporary contract number. Please note: only applicable with a new masterAgreement.
masterAgreement	contractNumber	I/O**	Number of the masterAgreement. Please note: mandatory input only with new particular contract, mandatory output only with new masterAgreement.
masterAgreement	effectiveDate	I/O**	Date on which the data of this entity takes/took effect. Please note: only applicable with a new masterAgreement.
policy	externalIndicative	I**	Identifying mark assigned by the agent. Can also be used as a temporary contract number. Please note: only applicable with new particular contract.
policy	contractNumber	O**	Number of a particular contract. Please note: only applicable with a new particular contract.
policy	effectiveDate	I/O**	Date on which the data of this entity takes/took effect. Please note: only applicable with a new particular contract.
party		I/O	With entityType policyHolder.
coverage	coverageCode	I/O**	Standardized code to indicate the type of coverage and the (group of) risk(s) against which the coverage has been / will be taken out. Please note: only applicable with a new particular contract.

Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
** See note in the remarks.