Get Policy Application Details

Use this endpoint to retrieve the details related to a specific policy application.

Get the details of an insurance policy

GEThttps://channel.sandbox.casava.co/api/channel-service/v1/policy/{policyNumber}

Authorization

api_key

Path parameters

policyNumber*string

policy number assigned to policy holder

Header parameters

Response

200400404

successful operation

Body

application/json

quoteId*string

unique identifier for a previously computed active quote

Example: "1234567889"

policyHolderNumber*string

policy holder system generated unique identifier

Example: "1728283928929"

policyNumber*string

unique reference used to identify a policy with a policy holder

Example: "1828292902039"

policyCode*string

unique reference code of the insurance policy

Example: "hosipcash"

statusenum

allowed data type for the field

Example: "applied"

quotedappliedacceptedinvalidatedissuedexpiredrenewedcancelledpaused

startDatestring

effective start date for the insurance policy

Example: "2021-10-10"

endDatestring

end date for the insurance policy

Example: "2022-10-10"

nextPremiumDueDatestring

next premium payment due date

Example: "2021-11-10"

redirectURLstring

URL to redirect the policy holder to continue policy validation or processing only applicable when status = applied

fieldValuesarray of PolicyFieldValues (object)

Request

JavaScriptCurlPython

const response = await fetch('https://channel.sandbox.casava.co/api/channel-service/v1/policy/{policyNumber}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "quoteId": "1234567889",
  "policyHolderNumber": "1728283928929",
  "policyNumber": "1828292902039",
  "policyCode": "hosipcash",
  "status": "applied",
  "startDate": "2021-10-10",
  "endDate": "2022-10-10",
  "nextPremiumDueDate": "2021-11-10",
  "redirectURL": "text",
  "fieldValues": [
    {
      "fieldGroupId": "fieldGroupA",
      "fielId": "fieldIdA",
      "value": "field id value"
    }
  ]
}

Sample Request

Pass the policy number via URL to the GET policy endpoint to retrieve policy information of a policy

Sample Response

Get the details of an insurance policy

{
  "statusCode": 200,
  "message": "successful operation",
  "data": {
    "quoteId": "9546916489",
    "policyHolderNumber": "080209934213519",
    "policyNumber": "XY2599220220304646202",
    "policyCode": "XY25992",
    "status": "applied",
    "startDate": "",
    "endDate": "",
    "nextPremiumDueDate": "",
    "redirectURL": "",
    "fieldValues": [
      {
        "key": "PERSONALINFO=>FIRSTNAME",
        "value": "stefanpgr"
      }
    ]
  }
}