[Beta – preprod] Retrieve a product for a company
GET/companies/:companyID/products/:productID
[Beta – preprod] Retrieve a product for a company
Request
Path Parameters
Responses
- 200
- 404
success - product details
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Catalogue name, falling back to the referential name.
Possible values: [custom, referential]
Explicit product kind: 'custom' when a custom_product row references this entry, 'referential' when it points to a referential product. Derived from the data, not from the unreliable productSource column.
establishment
object
nullable
required
Identifier of the insurer institution, null when only free-text insurer is known.
Insurer/establishment name (e.g. MMA, AFI ESCA), from the linked institution, falling back to the referential free-text insurer.
minimumAmounts
object
nullable
required
scheduledPayments
object
nullable
required
exitOptions
object
nullable
required
fees
object[]
required
true when the cabinet negotiated value overrides the default.
clauses
object
nullable
required
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"referentialId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"type": "custom",
"isActive": true,
"establishment": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string"
},
"marketed": true,
"commercializationStart": "string",
"commercializationEnd": "string",
"minimumAmounts": {
"initialDeposit": 0,
"additionalDeposit": 0,
"minArbitration": 0,
"minPartialWithdrawal": 0
},
"scheduledPayments": {
"monthly": 0,
"quarterly": 0,
"semiAnnual": 0,
"annual": 0
},
"exitOptions": {
"scheduledPartialWithdrawal": "string",
"floorGuarantee": "string",
"lifeAnnuity": "string",
"contractAdvance": "string",
"earlyExitPenalty": "string"
},
"fees": [
{
"feeType": "string",
"value": 0,
"unit": "string",
"frequency": "string",
"isNegotiated": true
}
],
"clauses": {
"beneficiaryClause": "string",
"advantagesAndRisks": "string",
"selectionJustification": "string"
}
}
Product not found