{"swaggerDoc":{"swagger":"2.0","info":{"version":"1.0.0","title":"MATRISQ REST API","description":"From PulseLabs"},"host":"matrisq.pulselabs.co.in","basePath":"/rest/api/v1/","schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/authenticate":{"post":{"tags":["Partner Login"],"description":"Partner login to generate a partner auth token","parameters":[{"required":true,"name":"body","in":"body","description":"Partner login information shared by Pulse Sales Team","schema":{"required":["access_key","access_token"],"properties":{"access_key":{"type":"string","example":"ACME"},"access_token":{"type":"string","example":"ACME"}}}}],"produces":["application/json"],"responses":{"200":{"description":"Partner auth token gets generated with a session of 30 mins.","schema":{"$ref":"#/definitions/STATUS_OK"}}}}},"/questionaire/list":{"post":{"tags":["Risk Questionaire"],"description":"This API is to fetch the risk questionaire.","parameters":[{"required":true,"name":"body","in":"body","description":"Auth Token generated using the 'Partner Login' API","schema":{"required":["auth_token"],"properties":{"auth_token":{"type":"string","example":"7a3643dc03064c17998df39a035c542f"}}}}],"produces":["application/json"],"responses":{"200":{"description":"Returns risk questionaire.","schema":{"$ref":"#/definitions/STATUS_OK"}}}}},"/questionaire/save":{"post":{"tags":["Risk Questionaire"],"description":"This API is to capture the client's risk profile or risk questionaire answers.","parameters":[{"required":true,"name":"body","in":"body","description":"auth : Auth Token generated using the 'Partner Login', answers: Array of user's answers.","schema":{"required":["auth_token","answers"],"properties":{"auth_token":{"type":"string","example":"uitXjmABZaFnLZVGxBda"},"answers":{"type":"array","example":[{"user_id":1000000,"question_id":1000028,"answer_type":"text_opt","answer":10}]}}}}],"produces":["application/json"],"responses":{"200":{"description":"Returns number of saved answers.","schema":{"$ref":"#/definitions/STATUS_OK"}}}}},"/questionaire/report":{"post":{"tags":["Risk Questionaire"],"description":"This API gives the Risk Report based on the user's Risk profile.","parameters":[{"required":true,"name":"body","in":"body","description":"auth_token : Auth Token generated using the 'Partner Login' API \n user_id : UserId - preferably a number.","schema":{"required":["auth_token","user_id"],"properties":{"auth_token":{"type":"string","example":"uitXjmABZaFnLZVGxBda"},"user_id":{"type":"string","example":"1000000"}}}}],"produces":["application/json"],"responses":{"200":{"description":"Returns Report category wise base on user's risk profile.","schema":{"$ref":"#/definitions/STATUS_OK"}}}}},"/questionaire/observations":{"post":{"tags":["Risk Observations"],"description":"This API gives the Risk Observations based on the answers provided by user.","parameters":[{"required":true,"name":"body","in":"body","description":"auth_token : Auth Token generated using the 'Partner Login' API \n user_id : UserId - preferably a number.","schema":{"required":["auth_token","user_id"],"properties":{"auth_token":{"type":"string","example":"uitXjmABZaFnLZVGxBda"},"user_id":{"type":"string","example":"1000000"}}}}],"produces":["application/json"],"responses":{"200":{"description":"Returns observations based on risk questions answered by user.","schema":{"$ref":"#/definitions/STATUS_OK"}}}}},"/questionaire/classification":{"post":{"tags":["Risk Classification"],"description":"This API gives the information about the rationale behind the risk weightage and classification.","parameters":[{"required":true,"name":"body","in":"body","description":"auth_token : Auth Token generated using the 'Partner Login' API.","schema":{"required":["auth_token"],"properties":{"auth_token":{"type":"string","example":"uitXjmABZaFnLZVGxBda"}}}}],"produces":["application/json"],"responses":{"200":{"description":"Returns the information about the rationale behind the risk weightage and classification.","schema":{"$ref":"#/definitions/STATUS_OK"}}}}},"/goal-simulator/simulate":{"post":{"tags":["Goal Simulator"],"description":"This API simulates how a goal can be acheieved based on goal start month, goal end month and goal value.","parameters":[{"required":true,"name":"body","in":"body","description":"auth_token : Auth Token generated using the 'Partner Login' API. \n goal_value: Goal Value to achieve in today's terms. \n goal_start: Goal start month, \n goal_period: Goal end month, \n inflation: inflation, \n iss: ISS, \n one_time: One time contribution during the first month of the goal, \n recurring: Contributuion every month","schema":{"required":["auth_token","goal_value","goal_start","goal_period","inflation","iss","one_time","recurring"],"properties":{"auth_token":{"type":"string","example":"uitXjmABZaFnLZVGxBda"},"goal_value":{"type":"number","example":"500000"},"goal_start":{"type":"string","example":"2019-04"},"goal_period":{"type":"string","example":"2029-03"},"inflation":{"type":"number","example":"5"},"iss":{"type":"number","example":"0"},"one_time":{"type":"number","example":"10000"},"recurring":{"type":"number","example":"1000"}}}}],"produces":["application/json"],"responses":{"200":{"description":"Returns the information about the rationale behind the risk weightage and classification.","schema":{"$ref":"#/definitions/STATUS_OK"}}}}}},"definitions":{"STATUS_OK":{"properties":{"status":{"$ref":"#/definitions/HTTP_200","example":"uitXjmABZaFnLZVGxBda"},"data":{"type":"string","example":"{}"}}},"HTTP_200":{"properties":{"code":{"type":"integer","example":200},"message":{"type":"string","example":"OK"}}}}},"customOptions":{}}