# Bharat Connect B2B ID Registration

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v0/business-onboarding/reg-id:
    post:
      summary: Bharat Connect B2B ID Registration
      deprecated: false
      description: >-

        :::highlight purple 📌

        Use this API to register a B2B ID on the Bharat Connect platform through
        your EnKash account.

        This enables business to be uniquely identified within the Bharat
        Connect ecosystem, allowing you to seamlessly engage in B2B transactions
        such as issuing or receiving invoices, managing purchase orders, and
        tracking payments.

        :::
      tags:
        - Bharat Connect (BBPS)/APIs - BBPS/Vendor Payment/Business Onboarding
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegistrationIdRequest'
            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-10664775-run
components:
  schemas:
    RegistrationIdRequest:
      type: object
      properties:
        initiatorEntity:
          type: string
        objectId:
          type: string
        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
              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
          required:
            - requestorB2BId
          x-apidog-orders:
            - requestorB2BId
          x-apidog-ignore-properties: []
        regB2BIds:
          type: object
          properties:
            ids:
              type: array
              items:
                type: object
                properties:
                  value:
                    type: string
                  privacyType:
                    type: string
                  reason:
                    type: string
                  description:
                    type: string
                  businessIdentifier:
                    type: object
                    properties:
                      documentName:
                        type: string
                      value:
                        type: string
                      registeredName:
                        type: string
                    required:
                      - documentName
                      - value
                      - registeredName
                    x-apidog-orders:
                      - documentName
                      - value
                      - registeredName
                    x-apidog-ignore-properties: []
                x-apidog-orders:
                  - value
                  - privacyType
                  - reason
                  - description
                  - businessIdentifier
                x-apidog-ignore-properties: []
          required:
            - ids
          x-apidog-orders:
            - ids
          x-apidog-ignore-properties: []
      required:
        - initiatorEntity
        - objectId
        - device
        - onboardingB2BIds
        - regB2BIds
      x-apidog-orders:
        - initiatorEntity
        - objectId
        - device
        - onboardingB2BIds
        - regB2BIds
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```
