API Document


Overview

Version information

Version 0.1.0

Contact information

Contact: EValue Support - support@ev.uk

URI scheme

Schemes: HTTP, HTTPS

Consumes

application/json

Produces

application/json

Paths

/lifeExpectancy/forecast

Description

Calculates the life expectancy of a person and an optional spouse based on their date of birth and gender. Please refer to the Pricing Plan and the Credits Plan for the number of credits required to call this API.

Parameters

Type Name Description Schema Required
BodyParameter body Parameters for life expectancy forecast LifeExpectancyParameters true

Responses

HTTP Code Description Schema
200 successful operation LifeExpectancyResult
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.

LifeExpectancyParameters

Name Description Schema Required Range
user The main user, the 'forecastee' User true  
forecastOptions Options dictating how the forecast should be processed ForecastOptions true  

User

Name Description Schema Required Range
dateOfBirth ISO-8601 formatted date of birth for the forcastee String (date) true  
gender Gender of the forcastee Enum - MALE, FEMALE true  
spouse Object containing information on the spouse of the forcastee Spouse  

Spouse

Name Description Schema Required Range
dateOfBirth ISO-8601 formatted date of birth of the forcastee's spouse String (date) true  
gender Gender of the forcastee's spouse Enum - MALE, FEMALE true  

ForecastOptions

Name Description Schema Required Range
percentiles Percentiles for which to return a result. The lowest result would be 0; the highest 100 List of Integer true  
retirementDate ISO-8601 formatted date at which the forecastee should retire in the forecast String (date) true  
taxOptions The Tax Options for the forecast TaxOptions true  

TaxOptions

Name Description Schema Required Range
region In addition to the tax jurisdiction, further specifies tax assumptions Enum - UK, SCOTLAND true  

Response

LifeExpectancyResult

Name Description Schema
results A list of result for each probability requested in the API input parameters List of LifeExpectancyProbabilityResult

LifeExpectancyProbabilityResult

Name Description Schema
probability The life expectancy result probability Integer
user The life expectancy of the forecastee Integer
spouse The life expectancy of the forecastee's spouse Integer
combined The combined life expectancy of the forecastee and the spouse Integer

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