Search
K
Illustration

Variable Value

the value of a variable, may be constant or time-dependent

One Of

Arrangement

object

Describes an arbitrary agreement

arrangementSourcesarray[object]

A source of funding for an arrangement

Show Child Parameters
typestring

Enumeration of allowable arrangement types

Allowed values:LOANWITHDRAWALPAYMENTCONVERSION_ACTIVATION

attributesobject

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

Show Child Parameters
requestedAmountOne Of

the value of a variable, may be constant or time-dependent

Variant 1string
deathClaimobject

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

Show Child Parameters
feesarray[object]

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

Show Child Parameters
loanSegmentsarray[object]

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

Show Child Parameters
matchSegmentobject

A segment of a source of money that has some form of financial activity

Show Child Parameters
paymentsarray[object]

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

Show Child Parameters
taxWithholdingsarray[object]

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

Show Child Parameters
Example

Arrangements

array

An unkeyed collection of arrangement objects

arrangementSourcesarray[object]

A source of funding for an arrangement

Show Child Parameters
typestring

Enumeration of allowable arrangement types

Allowed values:LOANWITHDRAWALPAYMENTCONVERSION_ACTIVATION

attributesobject

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

Show Child Parameters
requestedAmountOne Of

the value of a variable, may be constant or time-dependent

Variant 1string
deathClaimobject

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

Show Child Parameters
feesarray[object]

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

Show Child Parameters
loanSegmentsarray[object]

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

Show Child Parameters
matchSegmentobject

A segment of a source of money that has some form of financial activity

Show Child Parameters
paymentsarray[object]

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

Show Child Parameters
taxWithholdingsarray[object]

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

Show Child Parameters

Policy State

Represents the state of a policy at an instant in time. Describes the payload Zahara transmits when requesting calculations for a single transaction.

attributesobjectrequired

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

Show Child Parameters
accountValueobjectrequired

A description of the monetary value of an investment contract

Show Child Parameters
testValueobjectrequired

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

Show Child Parameters
deathBenefitobjectrequired

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

Show Child Parameters
coverageValueobjectrequired

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

Show Child Parameters
coveragesarray[object]required

A benefit conferred to a group of one or more participants

Show Child Parameters
partiesarray[object]requiredunique-items

A unique entity

Show Child Parameters
featuresobjectrequired

Well-known geatures associated with a policy

Show Child Parameters
fundAllocationsarray[object]required

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

Show Child Parameters
fundsarray[object]required

A source of money

Show Child Parameters
matchSegmentobjectrequired

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

Show Child Parameters
loanSegmentsarray[object]required

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

Show Child Parameters
arrangementsarray[object]required

Describes an arbitrary agreement

Show Child Parameters
Example

Result

array

The output from a cmputation, which may vary with time