Response Properties | Policy Status

This section outlines details of valid responses from the endpoint

For HTTP Status = 200

PropertyTypeDescriptionNullable
connection_idStringUnique identification for each policy request.No
dataJSONKey/Value JSON for each section status data.No
data.basic_policyPolicy Status CodeDefines the status of acquiring basic policy details for this policy requestNo
data.policy_holderPolicy Status CodeDefines the status of acquiring policy holder details for this policy requestNo
data.documentsPolicy Status CodeDefines the status of acquiring policy documents for this policy request.No
data.full_policyPolicy Status CodeDefines the status of acquiring full policy details for this policy requestNo
data.additional_consumer_dataPolicy Status CodeDefines the status of acquiring additional consumer details for this policy requestNo
{
  "connection_id": "fzTestRmSK4AuFz=",
  "data": {
    "basic_policy": "IN_QUEUE",
    "documents": "IN_QUEUE",
    "full_policy": "IN_QUEUE",
    "policy_details": "IN_QUEUE",
    "policy_discount": "IN_QUEUE",
    "policy_holder": "IN_QUEUE",
    "additional_consumer_data": "IN_QUEUE",
  }
}

For HTTP Status != 200

PropertyTypeDescription
typeEnum("success" , "failure")Value of this property defines whether the request made is succeeded or failed processing.
codeCommon Status CodeDefines a status code to denote the status of Policy data acqusition by the client
http_status_codeIntegerThis property contains HTTP status code. Range: 100 - 199 or 201 - 599
messageStringThis property contains message corresponding to code property
{
    "type": "failure",
    "code": "INVALID_CONNECTION_ID",
    "http_status_code": 400,
    "message": "Invalid connection_id"
}