How-To
How to use the Risk Questionnaire Profiler API
Request (1 of 3)
- In order to ascertain his attitude to risk, Bob needs to fill in a Risk questionnaire for his financial adviser.
- His adviser sends him a link to their on-line risk questionnaire.
Adviser tool sends API /riskProfiler/getQuestionnaireNames with no parameters.
Response (1 of 3)
- The names of the available risk questionnaires for the adviser to use are "5risk", "7risk" and "10risk".
{
"questionnaireNames": [
"5risk",
"7risk",
"10risk"
]
}
Request (2 of 3)
- Bob's adviser uses the questionnaire "5risk" in their online tool.
- The tool must retrieve the questions and possible answers for this questionnaire.
{
"questionnaireName": "5risk"
}
Response (2 of 3)
{
"name": "5risk",
"version": 1,
"questions": [{
"questionId": 1,
"questionText": "I would enjoy exploring investment opportunities for my money.",
"responses": [{
"responseText": "I strongly agree with this statement"
}, {
"responseText": "I tend to agree with this statement"
}, {
"responseText": "In between"
}, {
"responseText": "I tend to disagree with this statement"
}, {
"responseText": "I strongly disagree with this statement"
}]
}, {
"questionId": 2,
"questionText": "I would go for the best possible return even if there were risk involved",
"responses": [{
"responseText": "Always"
}, {
"responseText": "Usually"
}, {
"responseText": "Sometimes"
}, {
"responseText": "Rarely"
}, {
"responseText": "Never"
}]
}, {
"questionId": 3,
...
}]
}
Request (3 of 3)
- Bob answers the questions in the following way: 2,3,3,4,2,2,3,2,4,3,3,2,4
- Bob is intersted in investing over a 15-year term
{
"questionnaireName": "5risk",
"term": 15,
"responses": [{
"questionId": 1,
"responseId": 2
}, {
"questionId": 2,
"responseId": 3
}, {
"questionId": 3,
"responseId": 3
}, {
"questionId": 4,
"responseId": 4
}, {
"questionId": 5
"responseId": 2
}, {
"questionId": 6,
"responseId": 2
}, {
"questionId": 7,
"responseId": 3
}, {
"questionId": 8,
"responseId": 2
}, {
"questionId": 9,
"responseId": 4
}, {
"questionId": 10,
"responseId": 3
}, {
"questionId": 11,
"responseId": 3
}, {
"questionId": 12,
"responseId": 2
}, {
"questionId": 13,
"responseId": 4
}]
}
Response (3 of 3)
Please note that this example response is provided to show you the fields and format provided; the numbers do not reflect the results you would receive on the example request above.
Given Bob's answers to the ATR questionnaire, he is deemed to have an ATR score of 4.
{
"riskProfile": 4,
"riskProfileName": "4 - Moderate to Adventurous",
"riskProfileDescription": [
"You are prepared to take a medium degree of risk with your investment in return for the prospect of improving longer term investment performance.",
"Short term capital protection is not important to you and you are willing to sacrifice some long term protection for the likelihood of greater returns.",
"A typical Moderate to Adventurous investor will be invested mainly in equities but with other assets included to provide some diversification. There may be a small amount of specialised equity within the portfolio."
],
"allocations": [{
"code": "Asset_Class_Government_Bonds",
"name": "UK Government Bonds",
"contributionPercentage": 1
}, {
"code": "Portfolio_303",
"name": "UK equity",
"contributionPercentage": 28
}, {
"code": "Portfolio_304",
"name": "Overseas equity",
"contributionPercentage": 48
}, {
"code": "Portfolio_305",
"name": "Property",
"contributionPercentage": 7.5
}, {
"code": "Portfolio_309",
"name": "Corporate bonds",
"contributionPercentage": 15.5
}]
}