Get all policy holders

This endpoint allows get all policy holders information.

Get a list of policy holders based on specified conditions

Get a list of policy holders based on specified conditions

GEThttps://channel.sandbox.casava.co/api/channel-service/v1/policyHolder

Authorization

api_key

Query parameters

Header parameters

Response

200

successful operation

Body

application/json

policyHolderNumber*string

policy holder system generated unique identifier

Example: "123456789"

fullnamestring

policy holder fullname

Example: "John Doe"

emailstring

policy holder contact email address

Example: "[e-mail]"

phonestring

policy holder contact phone number

Example: "8027382929"

typeenum

allowed data type for the field

POLICY_HOLDERPARTNERAGENT

statusenum

allowed data type for the field

activesuspendedclosed

policiesarray of PolicyResponse (object)

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "policyHolderNumber": "123456789",
    "fullname": "John Doe",
    "email": "[e-mail]",
    "phone": "8027382929",
    "type": "POLICY_HOLDER",
    "status": "active",
    "policies": [
      {
        "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 Response

{
  "statusCode": 200,
  "message": "successful operation",
  "data": [
    {
      "fullname": "John Doe ",
      "email": "[e-mail]",
      "phone": "string",
      "type": "POLICY_HOLDER",
      "status": "active",
      "policyHolderNumber": "test101",
      "policies": [
        {
          "quoteId": "3871516489",
          "policyHolderNumber": "test101",
          "policyNumber": "XY2599220220303502150",
          "policyCode": "XY25992",
          "status": "applied",
          "startDate": "",
          "endDate": "",
          "nextPremiumDueDate": "",
          "redirectURL": "",
          "fieldValues": [
            {
              "key": "PERSONALINFO=>FIRSTNAME",
              "value": "stefanpgr"
            }
          ]
        }
      ]
    },
    {
      "fullname": "John Doe ",
      "email": "[e-mail]",
      "phone": "string",
      "type": "POLICY_HOLDER",
      "status": "active",
      "policyHolderNumber": "080209934213519",
      "policies": [
        {
          "quoteId": "9546916489",
          "policyHolderNumber": "080209934213519",
          "policyNumber": "XY2599220220304646202",
          "policyCode": "XY25992",
          "status": "applied",
          "startDate": "",
          "endDate": "",
          "nextPremiumDueDate": "",
          "redirectURL": "",
          "fieldValues": [
            {
              "key": "PERSONALINFO=>FIRSTNAME",
              "value": "stefanpgr"
            }
          ]
        }
      ]
    }
  ]
}