Skip to main content

​
Custom fields

Each policy, asset, customer, and claim has a list of custom fields which is configured at a product level, making it easy to adapt these core entities to any insurance product’s needs. Alongside custom fields, each entity has a shorter list of aggregate fields — properties of the entity itself rather than product-specific additions, such as an asset’s start date or a contract’s invoicing arrangement. They are configured with the same attributes, but they travel differently over the API: custom fields go inside a customFields array, aggregate fields are top-level properties. See Read the product configuration for the routing rules.

​
Custom field attributes

​
string
The field’s identifier, and what you send as the key of a customFields entry.
​
CustomFieldType
STRING, BOOLEAN, NUMBER, INTEGER, ENUM, DATE, DATETIME, EMAIL, PHONE_NUMBER, POSTCODE, SIRET, REGISTRATION_NUMBER, URL, IBAN or BIC. The narrower types carry their own format checks.
​
BusinessAction
The first business action that cannot proceed without the field: CREATION, QUOTE, CONFIRMATION or SIGNATURE. NOTHING and NEVER mean it is never required. Requirements accumulate, so confirming a contract means satisfying the creation and quote fields too.
​
BusinessAction
What changing the field invalidates back to — a field with QUOTE forces a re-quote after any change.
​
ModificationBehavior
ALLOWED or FORBIDDEN — whether the field may be changed during a mid-term adjustment or at renewal.
​
array
Constraints the platform enforces — maximum length, minimum and maximum values, and so on.
​
Applied when you send no value for the field.
Three further attributes mark fields whose value the platform owns rather than the caller:
​
IntegrationKey
The field is filled from an external source — a company registry, a vehicle registry, a telematics profile — and a value you send for it is replaced by the integration’s.
​
boolean
The field is derived by the platform, typically a pricing output. Sending it is rejected with INVALID_CUSTOM_FIELDS; read it back after quoting instead.
​
object
The field can be populated from a document the customer uploads — extractionSources: ["kbis"] reads it from a company registration extract. You may still set it yourself, but a successful extraction applies its own value.

​
Voice input (speech-to-text)

Free-text custom fields can offer voice input: next to the text area, a microphone button lets the user dictate their answer and have it transcribed into the field as they speak. This is convenient on mobile and for longer free-text entries such as a claim description.
Speech-to-text is configured per tenant — a speech-to-text provider is set up for the tenant — and then offered on individual free-text fields. It also relies on the browser granting microphone access. Where it is not configured — or the browser denies the microphone — the field simply falls back to normal typing, so no information is ever lost.
Example 1: B2B car insurance
  • Policy custom fields: killing questions results
  • Asset custom fields: car value, fiscal power, energy
  • Customer custom fields: siret, address, number of employees, ceo email
You could configure this product’s custom fields as such:
  • the asset’s fiscal power and energy are compulsory for quote calculation
  • the asset’s fiscal power and energy can only be modified in a mid term agreement with a new quote and signature
  • the asset’s car value is not required for quote, but because it appears in the contract document it is required for signature of the policy
  • the asset’s car value can be modified in a mid term agreement with only a new signature
  • the customer’s ceo email can be modified at any time
Example 2: B2C home insurance
  • Policy custom fields: documents are validated by broker
  • Asset custom fields: address, size, type (House or apartment)
  • Customer custom fields: first name, last name, monthly salary
You could configure this product’s custom fields as such:
  • the asset’s size and type are required for quoting
  • the asset’s size and type can only be modified in a mid term agreement with a new quote and signature
  • the asset’s address is required for the initial signing, but afterwards can be modified at any time
  • the customer’s first name and last name can be modified in a mid term agreement with a new contract signature
Once configured for a product, Korint will use these custom fields for various operations such as quoting, billing, and reports.