Get Policyholder by Policyholder Number

Use this endpoint to get information about a single policyholder by searching for their associated policyHolderNumber.

Get a list of policy holders based on specified conditions

get

Get a list of policy holders based on specified conditions

Authorizations

api_key

api_keystringRequired

Query parameters

emailstringOptional

Used to filter insurance policy holder by their email address

phoneNumberstringOptional

Used to filter insurance policy holder by their phone number

fullNamestringOptional

Used to filter insurance policy holder by their full name

policyHolderNumberstringOptional

Used to filter insurance policy holder by their policy holder reference number

pageSizeinteger · int32Optional

Number of result to display

Default: 50

pageIndexinteger · int32Optional

Page index

Default: 0

Header parameters

api_keyanyRequired

Responses

200

successful operation

application/json

policyHolderNumberstringRequired

policy holder system generated unique identifier

Example: 123456789

fullnamestringOptional

policy holder fullname

Example: John Doe

emailstringOptional

policy holder contact email address

Example: [email protected]

phonestringOptional

policy holder contact phone number

Example: 8027382929

typestring · enumOptional

allowed data type for the field

Possible values:

statusstring · enumOptional

allowed data type for the field

Possible values:

get

/policyHolder

HTTPcURLJavaScriptPython

GET /api/channel-service/v1/policyHolder HTTP/1.1
Host: channel.sandbox.casava.co
api_key: YOUR_API_KEY
Accept: */*

200

successful operation

[
  {
    "policyHolderNumber": "123456789",
    "fullname": "John Doe",
    "email": "[email protected]",
    "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 Request

https://channels.casava.co/api/v1/policyHolder?policyHolderNumber=08029292921

Sample Response

{
  "statusCode": 200,
  "message": "successful operation",
  "data": [
    {
      "fullname": "John Doe ",
      "email": "[email protected]",
      "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": "[email protected]",
      "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"
            }
          ]
        }
      ]
    }
  ]
}