Get Policy Details by Policy Number

Body Response - Schema

200 OK

policy_details_response:
  type: object
  properties:
    coverages:
      type: array
      items:
        type: object
        $ref: "#/definitions/coverage"
    effective_date:
      type: string
      format: date-time
    expiration_date:
      type: string
      format: date-time
    hop_dwellings:
      type: array
      items:
        type: object
        $ref: "#/definitions/hop_dwelling"
    hop_scheduled_personal_property_cov:
      type: object
      $ref: "#/definitions/hop_scheduled_personal_property"
    hop_valuable_personal_property:
      type: object
      $ref: "#/definitions/hop_valuable_personal_property"
    organization_name:
      type: string
    organization_type:
      type: string
    pa_vehicles:
      type: array
      items:
        type: object
        $ref: "#/definitions/vehicle"
    payment_schedule:
      type: array
      items:
        type: object
        $ref: "#/definitions/payment_schedule"
    policy_contacts:
      type: array
      items:
        type: object
        $ref: "#/definitions/policy_contact"
    policy_number:
      type: string
    primary_named_insured:
      type: string
    producer_code:
      type: string
    producer_code_desc:
      type: string
    product:
      type: string
    status:
      type: string

definitions:
  coverage:
    type: object
    properties:
      cov_terms:
        type: array
        items:
          type: object
          $ref: "#/definitions/cov_term"
      coverage_name:
        type: string

  hop_dwelling:
    type: object
    properties:
      dwelling_coverages:
        type: array
        items:
          type: object
          $ref: "#/definitions/dwelling_coverage"
      location_address:
        type: string
      location_number:
        type: integer
      territory_codes:
        type: array
        items:
          type: object
          $ref: "#/definitions/territory_code"

  hop_scheduled_personal_property:
    type: object
    properties:
      cov_scheduled_items:
        type: array
        items:
          type: object
          $ref: "#/definitions/cov_term_item"
      scheduled_properties:
        type: array
        items:
          type: object
          $ref: "#/definitions/scheduled_item_info"

  hop_valuable_personal_property:
    type: object
    properties:
      cov_scheduled_items:
        type: array
        items:
          type: object
          $ref: "#/definitions/cov_term_item"

  vehicle:
    type: object
    properties:
      color:
        type: string
      make:
        type: string
      model:
        type: string
      plate:
        type: string
      serial_number:
        type: integer
      state:
        type: string
      vehicle_coverages:
        type: array
        items:
          type: object
          $ref: "#/definitions/vehicle_coverage"
      vin:
        type: string
      year:
        type: integer

  payment_schedule:
    type: object
    properties:
      amount:
        type: string
      billing_due_date:
        type: string
        format: date-time
      statement_date:
        type: string
        format: date-time

  policy_contact:
    type: object
    properties:
      additional_interest:
        type: object
        $ref: "#/definitions/additional_interest_details"
      date_of_birth:
        type: string
        format: date-time
      email_address:
        type: string
      first_name:
        type: string
      gender:
        type: string
      last_name:
        type: string
      marital_status:
        type: string
      primary_address:
        type: string
      primary_phone_number:
        type: string
      role:
        type: string
      ssn:
        type: string

  territory_code:
    type: object
    properties:
      code:
        type: string

  cov_term:
    type: object
    properties:
      cov_term_name:
        type: string
      cov_term_value:
        type: string

  cov_term_item:
    type: object
    properties:
      clauses:
        type: array
        items:
          type: object
          $ref: "#/definitions/clause"

  dwelling_coverage:
    type: object
    properties:
      cov_terms:
        type: array
        items:
          type: object
          $ref: "#/definitions/cov_term"
      coverage_name:
        type: string

  scheduled_item_info:
    type: object
    properties:
      appraisal_info:
        type: string
      appraiser:
        type: string
      date_of_appraisal:
        type: string
        format: date-time
      description:
        type: string
      serial_no:
        type: string

  vehicle_coverage:
    type: object
    properties:
      cov_terms:
        type: array
        items:
          type: object
          $ref: "#/definitions/cov_term"
      coverage_name:
        type: string

  additional_interest_details:
    type: object
    properties:
      additional_interest_type:
        type: string
      certificate_required:
        type: boolean
      contract_number:
        type: string
      related_to:
        type: string

  clause:
    type: object
    properties:
      cov_terms:
        type: array
        items:
          type: object
          $ref: "#/definitions/cov_term"

400's

ErrorInfo:
  type: object
  properties:
    details:
      type: array
      items:
        type: object
        $ref: '#/definitions/ErrorDetails'
    developerMessage:
      type: string
    errorCode:
      type: string
    status:
      type: integer
    userMessage:
      type: string

definitions:
  ErrorDetails:
    type: object
    properties:
      message:
        type: string
      properties:
        type: object
        $ref: '#/definitions/ErrorDetailsProperties'
      stackTrace:
        type: string
  
  ErrorDetailsProperties:
    type: object
    properties:
      lineNumber:
        type: integer
      parameterLocation:
        type: string
      parameterName:
        type: string

❗️

API Availability

The Financial Services Experience Cloud for Insurance - Integrations Bridge is only available for customers enrolled in Talkdesk's Early Access (EA) program. To enter the EA program, contact a Customer Success Manager.

The Financial Services Experience Cloud for Insurance - Integrations Bridge has been in EA since November 2023.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Credentials
Header
Click Try It! to start a request and see the response here!