{"openapi":"3.1.0","info":{"title":"IndiaInsurances API","version":"1.0.0","description":"Every insurance product sold in India, read clause by clause from its own documents. Each fact carries a verbatim 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"}],"paths":{"/api/v1/policies":{"get":{"operationId":"searchPolicies","summary":"Search products","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"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/policy/{uin}":{"get":{"operationId":"getPolicy","summary":"One product with every fact, quote, clause and status","parameters":[{"name":"uin","in":"path","required":true,"description":"IRDAI Unique Identification Number of the product","schema":{"type":"string"}}],"responses":{"200":{"description":"The product","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/policy/{uin}/search":{"get":{"operationId":"searchPolicyText","summary":"Full-text search inside a product's documents","parameters":[{"name":"uin","in":"path","required":true,"description":"IRDAI Unique Identification Number of the product","schema":{"type":"string"}},{"name":"q","in":"query","required":true,"description":"Words to find","schema":{"type":"string"}}],"responses":{"200":{"description":"Matching clauses","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/clause/{id}":{"get":{"operationId":"getClause","summary":"The text of one clause","parameters":[{"name":"id","in":"path","required":true,"description":"Clause id","schema":{"type":"integer"}}],"responses":{"200":{"description":"The clause","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/compare":{"get":{"operationId":"comparePolicies","summary":"Two to four products side by side","parameters":[{"name":"uins","in":"query","required":true,"description":"Comma-separated UINs","schema":{"type":"string"}}],"responses":{"200":{"description":"Comparison rows","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/categories":{"get":{"operationId":"listCategories","summary":"Types of insurance","responses":{"200":{"description":"Categories","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/categories/{slug}/fields":{"get":{"operationId":"categoryFields","summary":"Fields read for a type of insurance","parameters":[{"name":"slug","in":"path","required":true,"description":"Category slug","schema":{"type":"string"}}],"responses":{"200":{"description":"Fields","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/insurers":{"get":{"operationId":"listInsurers","summary":"All insurers","responses":{"200":{"description":"Insurers","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/insurer/{slug}":{"get":{"operationId":"getInsurer","summary":"An insurer with metrics and products","parameters":[{"name":"slug","in":"path","required":true,"description":"Insurer slug","schema":{"type":"string"}}],"responses":{"200":{"description":"The insurer","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/law":{"get":{"operationId":"listLaw","summary":"Insurance law instruments","parameters":[{"name":"q","in":"query","required":false,"description":"Filter words","schema":{"type":"string"}}],"responses":{"200":{"description":"Instruments","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/law/{slug}":{"get":{"operationId":"getLaw","summary":"One instrument with sections","parameters":[{"name":"slug","in":"path","required":true,"description":"Instrument slug","schema":{"type":"string"}}],"responses":{"200":{"description":"The instrument","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/stats":{"get":{"operationId":"stats","summary":"Coverage counts and data date","responses":{"200":{"description":"Counts","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/help":{"post":{"operationId":"requestHelp","summary":"Add the user to the free help list (only with the user's consent)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["need","consent"],"properties":{"need":{"type":"string","enum":["buy","port","claim","review","other"]},"consent":{"type":"boolean","const":true},"email":{"type":"string"},"phone":{"type":"string"},"name":{"type":"string"},"city":{"type":"string"},"uin":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"200":{"description":"Added","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/corrections":{"post":{"operationId":"reportCorrection","summary":"Report a wrong or outdated fact","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"uin":{"type":"string"},"key":{"type":"string"},"message":{"type":"string"},"evidence":{"type":"string"},"email":{"type":"string"}}}}}},"responses":{"200":{"description":"Received","content":{"application/json":{"schema":{"type":"object"}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"Error":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"docs":{"type":"string"}}}}}}