Search
K
Illustration

Flat Extra

object
typestring

Type of flat extra

Allowed values:PERMANENTTEMPORARY

Example:PERMANENT

amountnumber(double)

Amount

Example:1000

durationnumber(integer)

Duration

Example:12

durationTypestring

Duration type

Allowed values:YEARSMONTHS

Example:YEARS

startDatestring(date)

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2025-05-13

Example

Participant-Collection

array

An unkeyed collection of unique participant objects

attributesobjectrequired

A collection of uniquely named variables, must be camel-cased.

Show Child Parameters
flatExtraarray[object]required

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters

Coverage (v3)

object

A benefit conferred to a group of one or more participants

attributesobjectrequired

A collection of uniquely named variables, must be camel-cased.

Show Child Parameters
participantsarray[object]requiredunique-items

An entity with a stake in a policy

Show Child Parameters
feesarray[object]required

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
Example

Coverage-Collection (v3)

array

A collection of benefits

attributesobjectrequired

A collection of uniquely named variables, must be camel-cased.

Show Child Parameters
participantsarray[object]requiredunique-items

An entity with a stake in a policy

Show Child Parameters
feesarray[object]required

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters

Party

object

A unique entity

attributesobjectrequired

A collection of uniquely named variables, must be camel-cased.

Show Child Parameters
personobjectrequired

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
organizationobjectrequired

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
trustobjectrequired

A simple object that only contains a collection of unique attributes and no further structure.

Show Child Parameters
Example