Skip to main content

Status Poll​

Retrieves consumer Response based on unique Request id

Path Parameters
    requestId Requestid required

    Request ID, as received in the response from the Quote API

Responses

Successful Response

Schema
    reqId string required

    Unique request identifier generated for the proposal status poll call.

    errors object[] required

    List of errors returned during execution. Empty array indicates success.

  • Array [
    • code string

    Error code identifier.

    message string

    Error message description.

  • ]
    • data object required
    applicationNumber string required

    Manufacturer/insurer application number used to track the proposal/policy.

    manufacturer object[] required

    Insurer-wise proposal/policy status details returned in the poll response.

  • Array [
    • insuranceCompanyCode string required

    Insurer code for which the status is returned.

    product object[] required

    Product-wise status details under the insurer.

  • Array [
    • productCode string required

    Product code under which the proposal/policy is processed.

    applicationStatus object required

    Current proposal/application status returned by insurer in poll response.

    applicationStatus string required

    Application status in readable format.

    applicationStatusDesc string required

    Description of the application status.

    manufacturerAppStatus string required

    Manufacturer/insurer-specific application status code.

    manufacturerAppStatusDesc string required

    Manufacturer/insurer-specific application status description.

    varFields object[] required

    Additional insurer/manufacturer fields for application status (if any).

  • Array [
    • fieldName string nullable

    Name of additional field.

    fieldValue string nullable

    Value of additional field.

  • ]
    • policyDetails object required

    Policy issuance details returned by insurer in poll response.

    policyNumber string required

    Issued policy number.

    policyStatus string required

    Policy status in readable format.

    policyStatusDesc string required

    Description of the policy status.

    manufacturerPolicyStatus string required

    Manufacturer/insurer-specific policy status code.

    manufacturerPolicyStatusDesc string required

    Manufacturer/insurer-specific policy status description.

    policyIssueDate string required

    Policy issuance date returned by insurer.

    policyEffectiveDate string required

    Policy start/effective date returned by insurer.

    policyEndDate string required

    Policy expiry/end date returned by insurer.

    policyRenewalDueDate string nullable required

    Policy due date returned by insurer (if applicable).

    wlcKitDispatchDate string nullable required

    Welcome kit dispatch date returned by insurer (if applicable).

    varFields object[] required

    Additional insurer/manufacturer fields for policy details (if any).

  • Array [
    • fieldName string nullable

    Name of additional field.

    fieldValue string nullable

    Value of additional field.

  • ]
    • premiumStatus object[] required

    Premium/payment status details returned by insurer in poll response.

  • Array [
    • premiumStatus string nullable required

    Premium status in readable format (if provided).

    premiumDesc string nullable required

    Premium status description (if provided).

    ManufacturerPremiumStatus string required

    Manufacturer/insurer-specific premium status.

    ManufacturerPremiumStatusDesc string required

    Manufacturer/insurer-specific premium status description.

    totalPremiumPaid string required

    Total premium paid amount.

    renewalAmountDue string nullable required

    Amount due (if provided by insurer).

    lastInsalmentPaymentDate string nullable required

    Last installment payment date (if applicable).

    paymentSource string nullable required

    Payment source/mode (if provided).

    premiumRenewalDueDate string nullable required

    Premium due date (if provided).

    autoPayment string nullable required

    Auto-payment indicator/status (if provided).

    varFields object[] required

    Additional insurer/manufacturer fields for premium status (if any).

  • Array [
    • fieldName string nullable

    Name of additional field.

    fieldValue string nullable

    Value of additional field.

  • ]
  • ]
    • varFields object[] required

    Additional insurer/manufacturer fields for product node (if any).

  • Array [
    • fieldName string nullable

    Name of additional field.

    fieldValue string nullable

    Value of additional field.

  • ]
  • ]
  • ]
    • isPollComplete boolean required

    Indicates whether the status poll is completed and final status is available.

Loading...