API Document


Overview

Version information

Version 1.0.0

Contact information

Contact: EValue Support - support@ev.uk

URI scheme

Schemes: HTTP, HTTPS

Consumes

application/json

Produces

application/json

Paths

/capacityForLoss/forecast

Description

Forecasting risk profiles to determine which achieves target with a high likelihood.

Parameters

Type Name Description Schema Required
BodyParameter body Parameters for Capacity For Loss CapacityForLossParameters true

Responses

HTTP Code Description Schema
200 successful operation CapacityForLossResult
400 Validation errors ValidationErrors
500 System error SystemError

Definitions

Request

Please note that only the following Definitions will be used when calculating the Result of this API call. Any other data submitted will not be validated or used in the calculation.

CapacityForLossParameters

Name Description Schema Required Range
balance Lump sum amount to be invested Double true  
contributions Any additional money paid into your asset, either as a regular saving or as a one off payment. Could be paid by the employee or the employer or a combination of both. Contributions  
riskGroup User's risk benchmark to which their investment can be evaluated Integer true  
term Terms for which to return a result, between 1 and 75 years. Integer true 1 to 75
target Decimal value of the target Double true  
percentile Percentile for which to return a result. The lowest result would be 0; the highest 100 Integer true 0 to 100

Contributions

Name Description Schema Required Range
amount Regular contribution to be included in the forecast Double true  
frequency Frequency of regular contribution Enum - WEEKLY, MONTHLY, QUARTERLY, ANNUALLY true  
increase Increase to apply to regular contributions (Increase applied annually) Increase  

Increase

Name Description Schema Required Range
basis The underlying index to base the increase on. This can be one of NONE, RPI, CPI or AWE (average weekly earnings) Enum - NONE, RPI, CPI, AWE  
rate An additional rate of increase to apply each year on top of the increase basis. For a fixed increase rate basis should be set to NONE and rate to the fixed increase (i.e. basis = NONE, rate = 2.5 would use fixed 2.5% increases each year) Double -100 to 100

Response

CapacityForLossResult

Name Description Schema
riskResults The forecast result gross values for each risk profile List of RiskResult
riskProfileCapacity The highest risk profile which satisfies the user's target Integer

RiskResult

Name Description Schema
risk Individual risk profile result Integer
value The forecast result gross value for the relevant risk profile Double

ValidationErrors

Name Description Schema
errors A list of errors from validating the API input parameters List of ValidationError

ValidationError

Name Description Schema
field The field that is invalid String
code The type of validation error that has occurred Enum - REQUIRED, OUT_OF_RANGE, INVALID, INVALID_TOTAL
message The validation error message String
value The value that is invalid String

SystemError

Name Description Schema
systemError The system error message. String