IndiaCos Defaulter API

openapi: 3.2.0
info:
  title: IndiaCos Defaulter API
  version: 2.0.0
  description: 'Prepaid API (sign up at https://indiacos.com/signup for ₹50 of free credit, then ₹0.40 per successful call; HTTP 402 insufficient_balance when the wallet is empty; agents: https://indiacos.com/auth.md; docs at https://indiacos.com/api/docs) to Indian companies and LLPs (status, capital, registered office, charges, GST filings), GST registrations, PAN lookups, directors, name pages, shared addresses, search and court-case summaries, one record at a time, under the IndiaCos Data Licence (https://indiacos.com/terms#licence): internal business use, commercial included, and showing individual records to your own users are allowed; resale or redistribution of the data, building a competing database and AI training need a written licence (support@indiacos.com). There are no bulk downloads.'
  contact:
    email: support@indiacos.com
  license:
    name: IndiaCos Data Licence
    url: https://indiacos.com/terms#licence
servers:
- url: https://indiacos.com/api/v1
security:
- bearer: []
- apiKey: []
- oauth:
  - api
tags:
- name: Defaulter
paths:
  /defaulter/{id}:
    get:
      summary: 'One defaulter from the public defaulter lists: every entry as published (list…'
      operationId: getDefaulter
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          pattern: ^[a-z2-7]{12}$
        description: The 12 characters at the end of a /defaulters/ page URL
        example: mrw3e3pc23p4
      responses:
        '200':
          description: Defaulter
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Defaulter
  /defaulter/search:
    get:
      summary: Public defaulter lists of India (bank wilful and large defaulters reported to…
      operationId: searchDefaulters
      parameters:
      - name: q
        in: query
        schema:
          type: string
        description: Words of the name
      - name: list
        in: query
        schema:
          type: string
        description: wd_sf, wd_nsf, ld_sf, sebi_recovery, listing_fines, suspended, delisted, broker_default, gem_debarred, worldbank, esic, mca_alert
      - name: state
        in: query
        schema:
          type: string
        description: State name (maharashtra)
      - name: lender
        in: query
        schema:
          type: string
        description: Lender name (State Bank of India)
      - name: cin
        in: query
        schema:
          type: string
        description: CIN of the borrower or a guarantor company
      - name: din
        in: query
        schema:
          type: string
        description: DIN of a director or guarantor
      - name: pan
        in: query
        schema:
          type: string
        description: PAN or its last four characters (lists publish PANs masked)
      - name: current
        in: query
        schema:
          type: string
        description: 'true: only entries in the latest lists'
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 50
      - name: offset
        in: query
        schema:
          type: integer
          minimum: 0
          maximum: 10000
          default: 0
      responses:
        '200':
          description: '{results, limit, offset, has_more, order}'
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Defaulter
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        docs:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: API key of your IndiaCos account (https://indiacos.com/signup)
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
    oauth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://indiacos.com/oauth/authorize
          tokenUrl: https://indiacos.com/oauth/token
          refreshUrl: https://indiacos.com/oauth/token
          scopes:
            api: Use the API, billed to the wallet