Lists (Carriers, Underwriters, Portfolios)

List Carriers (v1, v2, v3)

Endpoint

GET https://www.clarinetlive.com/api/latest/carriers

Responses

Below are listed some specific responses for this endpoint. General information about responses, status codes and errors can be found in Responses and Errors.

Code Response

// 200
[
     {
         "name": "4 Ever Life Insurance Company",
         "naic": "80985"
     },
     {
         "name": "5 Star Life Insurance Company",
         "naic": "77879"
     },
]

List Underwriters (v1, v2, v3)

Endpoint

GET https://www.clarinetlive.com/api/latest/underwriters

Import/Export This list is updated very infrequently, when a new Medical Underwriter business starts operating, or when one becomes inactive. When a Medical Underwriter ceases to trade, it is marked as Inactive, and the corresponding field set to true. ClariNet LS will accept the name of the Underwriter with the string " (Inactive)" appended after the name as a valid name as well as the name alone for inactive Underwriters. For example "EMSI" or "EMSI (Inactive)" are both accepted.

It is up to your user interface to handle the distinction between active and inactive, if at all. The "name" property, even for defunct entities will always remain valid as old reports must still be recorded under that name. You could for example show the inactive Underwriters at the end of a list rather than alphabetically.

Responses

Below are listed some specific responses for this endpoint. General information about responses, status codes and errors can be found in Responses and Errors.

Code Response

// 200
[
     {
         "name": "AVS",
         "isInactive": false
     },
    {
         "name": "Convergence",
         "isInactive": false
     },
]

List Portfolios (v2)

Endpoints

GET

https://www.clarinetlive.com/api/latest/portfolios?portfolioName=<portfolio name>

GET

https://www.clarinetlive.com/api/latest/portfolios?snapshot=<true or false>

GET

https://www.clarinetlive.com/api/latest/portfolios?createdOnOrAfter=<date>

Role

Portfolio View

Request

A request may use any combination of the 3 ltering parameters (portfolioName, snapshot, createdOnOrAfter). portfolioName may contain just a fragment. All Portfolios with names containing the fragment will be returned. createdOnOrAfter should contain a date in YYYY-MM-DD format.

Responses

Below are listed some specific responses for this endpoint. General information about responses, status codes and errors can be found in Responses and Errors.

Code Response

// 200
[
     {
         "name": "Portfolio 1",
         "folderName": null,
          "isSnapshot": false,
          "createdDate": "2020-05-17T15:33:00.000",
          "createdBy": "GeoffFakename",
          "caseReferences": ["Case 1", "Case 7"]
     },
    {
          "name": "Portfolio 7",
          "folderName": "Icarus_Snapshots",
          "isSnapshot": true,
          "createdDate": "2011-09-24T10:28:46.597",
          "createdBy": "StephanieAlsofake",
          "caseReferences": ["Franks", "ABC123"]
    }
]