Policy Application

This endpoint allows you to apply for a policy.

Used to apply for a policy from a quote id

POSThttps://channel.sandbox.casava.co/api/channel-service/v1/policy/apply

Authorization

api_key

Header parameters

Body

application/json

Used to apply for a policy from a quote id

quoteId*string

unique identifier for a previously computed active quote

Example: "123456789"

policyHolderNumber*string

optional policy holder identier

Example: "policy holder number"

paymentReferencestring

Must pass only after payment is complete using this reference, optional if payment is not required

Example: "casava_37215048"

isSubmissionboolean

default values is true, when true validate that all required field values have been sent before accepting policy application.

Example: true

policyCode*string

Insurance policy code

Example: "INCOMEPROTECT"

salarynumber

Only required if applying for INCOME PPROTECTION policy

Example: 90000

fieldValuesarray of PolicyFieldValues (object)

Response

201400

insurance policy application submitted successfully

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/apply', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "policyHolderNumber": "policy holder number",
      "quoteId": "123456789",
      "policyCode": "INCOMEPROTECT"
    }),
});
const data = await response.json();

Response

201400

{
  "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

{
"quoteId": "5149216544",
  "policyHolderNumber": "20220506865011",
  "paymentReference": "casava_37215048",
  "isSubmission": true,
  "policyCode": "INCOMEPROTECT",
  "salary": 90000,
  "fieldValues": [
    {
      "fieldGroupId": "HOMEADDRESS",
      "fieldId": "COUNTRY",
      "value": "Nigeria"
    },
     {
      "fieldGroupId": "HOMEADDRESS",
      "fieldId": "STATE",
      "value": "LAGOS"
    }
  ]

}

Sample Response

After applying for a policy using the QuoteId a response will be returned containing the policy number

{
  "statusCode": 201,
  "message": "insurance policy application submitted successfully",
  "data": {
    "quoteId": "9546916489",
    "policyHolderNumber": "080209934213519",
    "policyNumber": "XY2599220220304646202",
    "policyCode": "XY25992",
    "status": "applied",
    "startDate": "",
    "endDate": "",
    "nextPremiumDueDate": "",
    "redirectURL": "",
    "fieldValues": [
      {
        "key": "PERSONALINFO=>FIRSTNAME",
        "value": "stefanpgr"
      }
    ]
  }
}