This section outlines details of valid responses from the endpoint
For HTTP Status = 200
Property | Type | Description | Nullable |
---|---|---|---|
connection_id | String | Unique identification for each policy request. | No |
data | JSON | Key/Value JSON for each section status data. | No |
data.basic_policy | Policy Status Code | Defines the status of acquiring basic policy details for this policy request | No |
data.policy_holder | Policy Status Code | Defines the status of acquiring policy holder details for this policy request | No |
data.documents | Policy Status Code | Defines the status of acquiring policy documents for this policy request. | No |
data.full_policy | Policy Status Code | Defines the status of acquiring full policy details for this policy request | No |
data.additional_consumer_data | Policy Status Code | Defines the status of acquiring additional consumer details for this policy request | No |
{
"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
Property | Type | Description |
---|---|---|
type | Enum("success" , "failure") | Value of this property defines whether the request made is succeeded or failed processing. |
code | Common Status Code | Defines a status code to denote the status of Policy data acqusition by the client |
http_status_code | Integer | This property contains HTTP status code. Range: 100 - 199 or 201 - 599 |
message | String | This property contains message corresponding to code property |
{
"type": "failure",
"code": "INVALID_CONNECTION_ID",
"http_status_code": 400,
"message": "Invalid connection_id"
}