# Search Entity

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/business-onboarding/req-search-entity:
    post:
      summary: Search Entity
      deprecated: false
      description: >-

        :::highlight purple 📌

        Use this API to search for entities based on filters B2B ID, or status.
        This helps you quickly find and manage registered entities in the
        system.

        :::
      tags:
        - Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Business Onboarding
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchEntityRequest'
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  response_code:
                    type: integer
                  response_message:
                    type: string
                  payload:
                    type: string
                required:
                  - response_code
                  - response_message
                  - payload
                x-apidog-orders:
                  - response_code
                  - response_message
                  - payload
                x-apidog-ignore-properties: []
              example:
                response_code: 0
                response_message: SUCCESS
                payload: string
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Business Onboarding
      x-apidog-status: developing
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-10664773-run
components:
  schemas:
    SearchEntityRequest:
      type: object
      properties:
        initiatorEntity:
          type: string
        objectId:
          type: string
          pattern: ^[ORG]{3}[A-Za-z0-9]{32,32}$
        device:
          type: object
          properties:
            tag:
              type: object
              properties:
                name:
                  type: string
                  enum:
                    - GEOCODE
                    - IP
                    - AGENTID
                  x-apidog-enum:
                    - value: GEOCODE
                      name: ''
                      description: ''
                    - value: IP
                      name: ''
                      description: ''
                    - value: AGENTID
                      name: ''
                      description: ''
                value:
                  type: string
                  pattern: ^([^\\\"]){1,100}$
              required:
                - name
                - value
              x-apidog-orders:
                - name
                - value
              x-apidog-ignore-properties: []
          required:
            - tag
          x-apidog-orders:
            - tag
          x-apidog-ignore-properties: []
        onboardingB2BIds:
          type: object
          properties:
            requestorB2BId:
              type: string
              pattern: ^([^\\\"]){1,100}$
          required:
            - requestorB2BId
          x-apidog-orders:
            - requestorB2BId
          x-apidog-ignore-properties: []
        search:
          type: object
          properties:
            criteria:
              type: array
              items:
                type: object
                properties:
                  searchParameter:
                    type: string
                    enum:
                      - GSTIN
                      - UDYAM
                      - SHOP ESTABLISHMENT CERTIFICATE
                      - PAN
                      - TAN
                      - IEC
                      - LEI
                      - FACTORY LICENSE NUMBER
                      - DRUG LICENSE NUMBER
                      - TOURISM LICENSE NUMBER
                      - FDA
                      - FSSAI
                      - HEALTH AND TRADE LICENSE NUMBER
                      - LABOR LICENSE NUMBER
                      - BROADCASTING AND TELECOM LICENSE NUMBER
                      - B2BID
                    x-apidog-enum:
                      - value: GSTIN
                        name: ' '
                        description: ''
                      - value: UDYAM
                        name: ' '
                        description: ''
                      - value: SHOP ESTABLISHMENT CERTIFICATE
                        name: ''
                        description: ''
                      - value: PAN
                        name: ' '
                        description: ''
                      - value: TAN
                        name: ' '
                        description: ''
                      - value: IEC
                        name: ' '
                        description: ''
                      - value: LEI
                        name: ' '
                        description: ''
                      - value: FACTORY LICENSE NUMBER
                        name: ' '
                        description: ''
                      - value: DRUG LICENSE NUMBER
                        name: ' '
                        description: ''
                      - value: TOURISM LICENSE NUMBER
                        name: ' '
                        description: ''
                      - value: FDA
                        name: ' '
                        description: ''
                      - value: FSSAI
                        name: ''
                        description: ''
                      - value: HEALTH AND TRADE LICENSE NUMBER
                        name: ' '
                        description: ''
                      - value: LABOR LICENSE NUMBER
                        name: ' '
                        description: ''
                      - value: BROADCASTING AND TELECOM LICENSE NUMBER
                        name: ' '
                        description: ''
                      - value: B2BID
                        name: ''
                        description: ''
                  operator:
                    type: string
                    enum:
                      - EXACT
                    x-apidog-enum:
                      - value: EXACT
                        name: ''
                        description: ''
                  value:
                    type: string
                    pattern: ^([^\\\"]){1,50}$
                x-apidog-orders:
                  - searchParameter
                  - operator
                  - value
                required:
                  - searchParameter
                  - operator
                  - value
                x-apidog-ignore-properties: []
          required:
            - criteria
          x-apidog-orders:
            - criteria
          x-apidog-ignore-properties: []
      required:
        - initiatorEntity
        - objectId
        - device
        - onboardingB2BIds
        - search
      x-apidog-orders:
        - initiatorEntity
        - objectId
        - device
        - onboardingB2BIds
        - search
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```