# Initiate Entity Check

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/business-onboarding/reg-check-entity:
    post:
      summary: Initiate Entity Check
      deprecated: false
      description: >-

        :::highlight purple 📌

        Use this API to submit an entity’s details for verification. This
        ensures the entity meets compliance requirements and is ready for
        onboarding to the Bharat Connect Platform

        :::
      tags:
        - Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Business Onboarding
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegistrationCheckEntityRequest'
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  payload:
                    type: string
                  response_code:
                    type: integer
                  response_message:
                    type: string
                required:
                  - payload
                  - response_code
                  - response_message
                x-apidog-orders:
                  - payload
                  - response_code
                  - response_message
                x-apidog-ignore-properties: []
              example:
                payload: SUCCESS
                response_code: 0
                response_message: SUCCESS
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Business Onboarding
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-10664772-run
components:
  schemas:
    RegistrationCheckEntityRequest:
      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: ^[A-Za-z0-9]^([^\\\"]){1,100}$
              required:
                - name
                - value
              x-apidog-orders:
                - name
                - value
              x-apidog-ignore-properties: []
          required:
            - tag
          x-apidog-orders:
            - tag
          x-apidog-ignore-properties: []
        checkInstitute:
          type: object
          properties:
            docName:
              type: string
              enum:
                - PAN
              x-apidog-enum:
                - value: PAN
                  name: ''
                  description: ''
            type:
              type: string
              enum:
                - SOLE PROP
                - BOI
                - AOP
                - HUF
                - COMPANY
                - LLP
                - PARTNERSHIP FIRM
                - TRUST
                - GOVERNEMNT AGENCY
                - LOCAL AUTHORITY
                - AJP
              x-apidog-enum:
                - value: SOLE PROP
                  name: ' '
                  description: ''
                - value: BOI
                  name: ' '
                  description: ''
                - value: AOP
                  name: ''
                  description: ''
                - value: HUF
                  name: ' '
                  description: ''
                - value: COMPANY
                  name: ' '
                  description: ''
                - value: LLP
                  name: ''
                  description: ''
                - value: PARTNERSHIP FIRM
                  name: ''
                  description: ''
                - value: TRUST
                  name: ' '
                  description: ''
                - value: GOVERNEMNT AGENCY
                  name: ' '
                  description: ''
                - value: LOCAL AUTHORITY
                  name: ' '
                  description: ''
                - value: AJP
                  name: ''
                  description: ''
            value:
              type: string
              pattern: ^[a-zA-Z0-9]{50}$
            registeredName:
              type: string
              pattern: '^([^\\\"])*$ '
              minLength: 1
              maxLength: 256
          required:
            - docName
            - type
            - value
            - registeredName
          x-apidog-orders:
            - docName
            - type
            - value
            - registeredName
          x-apidog-ignore-properties: []
      required:
        - initiatorEntity
        - objectId
        - device
        - checkInstitute
      x-apidog-orders:
        - initiatorEntity
        - objectId
        - device
        - checkInstitute
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```