Policy Application

This endpoint allows you to apply for a policy.

Used to apply for a policy from a quote id

post

Authorizations

Header parameters

api_keyanyRequired

Body

quoteIdstringRequired

unique identifier for a previously computed active quote

Example: 123456789

policyHolderNumberstringRequired

optional policy holder identier

Example: policy holder number

paymentReferencestringOptional

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

Example: casava_37215048

isSubmissionbooleanOptional

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

Default: trueExample: true

policyCodestringRequired

Insurance policy code

Example: INCOMEPROTECT

salarynumberOptional

Only required if applying for INCOME PPROTECTION policy

Example: 90000

Responses

201

insurance policy application submitted successfully

application/json

400

Validation error submitting insurance appliation

application/json

post

HTTPcURLJavaScriptPython

POST /api/channel-service/v1/policy/apply HTTP/1.1
Host: channel.sandbox.casava.co
api_key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 260

{
  "quoteId": "123456789",
  "policyHolderNumber": "policy holder number",
  "paymentReference": "casava_37215048",
  "isSubmission": true,
  "policyCode": "INCOMEPROTECT",
  "salary": 90000,
  "fieldValues": [
    {
      "fieldGroupId": "fieldGroupA",
      "fielId": "fieldIdA",
      "value": "field id value"
    }
  ]
}

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