5.4.5. Special limit

The operation specialLimit requests and sends messages and registers contracts with conditions that deviate from the usual (standard) conditions. If contracts would have fit in the usual conditions the operation new would have been applicable.

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

How to use variants

A complete dataset/structure of the contract should be delivered in order to be able to determine the special conditions (special limits).

A positive response for the operation specialLimit 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).
• If the operation is not accepted, then the status is rejected (afgewezen).
• If the operation 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 operation specialLimit has multiple variants for acceptance, registration and notification of contracts with special limit conditions.

U/C: Under construction.

<default> – Request acceptance of a contract under special limit conditions

The variant default requests acceptance of a contract under special limit conditions deviating from the standard conditions.

policyStructure

The policyStructure is used to accept a policy under special conditions. This situation could occur in cases of policies accepted through agents with power of attorney. 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/special-limits/request	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	effectiveDate	I/O	Date on which the data of this entity takes/took effect.
policy	specialLimit	O	A special limit applies when underwriting agents are not allowed to handle the underwriting themselves, but require approval from the company.
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 accept a masterAgreement under special conditions. 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/special-limits/request	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/O	Number of the masterAgreement within the entityType package.
policy	effectiveDate	I/O	Date on which the data of this entity takes/took effect.
policy	specialLimit	O	A special limit applies when underwriting agents are not allowed to handle the underwriting themselves, but require approval from the company.
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.

registration – Registration of an underwritten contract outside the standard scope of the (MGA) agreement

This variant is used for registration of an underwritten contract deviating from the standard conditions.

policyStructure

The policyStructure is used for registration of an underwritten policy, deviating from the standard conditions. 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/special-limits/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/O	Identifying mark assigned by the agent. Can also be used as a temporary contract number.
policy	contractNumber	O	Number of the contract.
policy	paymentTermInMonths	I/O	The payment term is necessary to calculate the premium amount for the given term; monthly, bimonthly, quarterly, semesterly.
policy	effectiveDate	I/O	Date on which the data of this entity takes/took effect.
policy	specialLimit	I/O	A special limit applies when underwriting agents are not allowed to handle the underwriting themselves, but require approval from the company.
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 for registration of an underwritten masterAgreement deviating from the standard conditions. 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/special-limits/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 process (codelist ADNSTS) within the entityType transaction.
masterAgreement	contractNumber	I/O	Number of the masterAgreement within the entityType package.
policy	externalIndicative	I/O	Identifying mark assigned by the agent. Can also be used as a temporary contract number.
policy	contractNumber	O	Number of a particular contract.
policy	effectiveDate	I/O	Date on which the data of this entity takes/took effect.
policy	paymentTermInMonths	I/O	The payment term is necessary to calculate the premium amount for the given term; monthly, bimonthly, quarterly, semesterly.
policy	specialLimit	I/O	A special limit applies when underwriting agents are not allowed to handle the underwriting themselves, but require approval from the company.
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.