Skip to main content

Create CSM Run

  • method: POST
  • headers:
    • content-type: application/json
    • authorization: API Key token
  • endpoint: /csm/lrc

request body payload

  • valuation_date: string. valuation date. required format YYYY-MM-DD.
  • policy_data: array of objects.
  • ratios: object with multiple keys. contains 'initial_measurement' (required) and 'subsequent_measurement' (optional).

Required policy_data and the structure of ratios is from the response of POST at '/csm'.

sample request

curl --location 'https://api.i17.actserv-africa.com/api/v2/csm/lrc' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-KEY-goes-here' \
--data '{
    "valuation_date:": "2022-12-31",
    "ratios": {
        "initial_measurement": {
            "ra_ratio": [
                {
                    "class": "Engineering",
                    "2021": 0
                },
                {
                    "class": "Miscellaneous",
                    "2021": 0
                }
            ],
            "expense_ratio": [
                {
                    "class": "Engineering",
                    "2021": 9.8
                },
                {
                    "class": "Miscellaneous",
                    "2021": 12.0
                }
            ]
        },
        "subsequent_measurement": {
            "ra_ratio": [
                {
                    "class": "Engineering",
                    "2021": 0
                },
                {
                    "class": "Miscellaneous",
                    "2021": 0
                }
            ],
            "expense_ratio": [
                {
                    "class": "Engineering",
                    "2021": 9.8
                },
                {
                    "class": "Miscellaneous",
                    "2021": 12.0
                }
            ]
        }
    },
    "policy_data": [
        {
            "policy_no": "01/01/127/10608/2020",
            "end_no": "New",
            "class": "Miscellaneous",
            "sub_class": "Performance Bonds ",
            "underwriting_date": "2020-01-02",
            "policy_commencement_date": "2020-01-02",
            "policy_end_date": "2020-03-31",
            "gross_premium_amount": 1000,
            "acquisition_costs": 100
        },
        {
            "policy_no": "01/01/120/8936/2020",
            "end_no": "New",
            "class": "Miscellaneous",
            "sub_class": "Bonds (Immigration) ",
            "underwriting_date": "2020-01-02",
            "policy_commencement_date": "2020-01-02",
            "policy_end_date": "2021-01-01",
            "gross_premium_amount": 2500,
            "acquisition_costs": 250
        }
    ]
}

response payload

  • code: http status of the response
  • msg: message
  • results: Details of the created run.

sample response

{
    "code": 200,
    "msg": "success",
    "results": {
        "run_id": "csm__20241121__run-1-id",
        "run_name": "XYZ :: csm :: 2024-11-21",
        "created_by": "johndoe@mail.com",
        "date_and_time": "2024-11-21 07:09:52 UTC"
    }
}