IndiaInsurances Policies API

openapi: 3.2.0
info:
  title: IndiaInsurances Policies API
  version: 1.0.0
  description: The insurance products on the IRDAI registers with their own documents; most of the ones on sale read clause by clause (most by one machine reading, marked so). Each fact carries the verbatim policy para (field `quote`), the clause and page it came from, and a check status; "not-stated" means the documents do not say. Free, no key, 120 requests a minute per IP. Information, not advice.
  contact:
    email: support@indiainsurances.com
    url: https://indiainsurances.com/for-agents
  termsOfService: https://indiainsurances.com/terms
servers:
- url: https://indiainsurances.com
tags:
- name: Policies
paths:
  /api/v1/policies:
    get:
      operationId: searchPolicies
      summary: Search products
      description: Each word of q must be in the product name or the insurer name ("niva bupa reassure"); close spellings and a UIN also match. Best matches first.
      parameters:
      - name: q
        in: query
        required: false
        description: Name words or a UIN
        schema:
          type: string
      - name: category
        in: query
        required: false
        description: Category slug
        schema:
          type: string
      - name: insurer
        in: query
        required: false
        description: Insurer slug
        schema:
          type: string
      - name: line
        in: query
        required: false
        description: life, health or general
        schema:
          type: string
      - name: status
        in: query
        required: false
        description: active or withdrawn
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Max 100
        schema:
          type: integer
      - name: offset
        in: query
        required: false
        description: Paging offset
        schema:
          type: integer
      responses:
        '200':
          description: Matching products
          content:
            application/json:
              schema:
                type: object
        '429':
          description: More than 120 requests a minute from this address
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Policies
  /api/v1/policies/find:
    get:
      operationId: findPolicies
      summary: Shortlist active products of one type by what their documents say
      description: Conditions on the category's bool, duration and number fields (see /api/v1/categories/{slug}/fields), in the field's unit. Only products that state each value are listed, with the matching values and policy paras. A bad key returns the allowed keys.
      parameters:
      - name: category
        in: query
        required: true
        description: Category slug, e.g. health-indemnity
        schema:
          type: string
      - name: where
        in: query
        required: true
        description: 'Comma-separated key<=n, key>=n or key=n (yes/no fields: =1 or =0), e.g. ped_waiting<=24,lifelong_renewal=1'
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Max 100
        schema:
          type: integer
      responses:
        '200':
          description: Matching products with the matched facts
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad or missing parameter (see error and message)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: More than 120 requests a minute from this address
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Policies
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        docs:
          type: string