Initiate Entity Check

POST

/api/v0/business-onboarding/reg-check-entity

📌

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

Request

Body Params application/json

initiatorEntity

string

required

objectId

string

required

Match pattern:

^[ORG]{3}[A-Za-z0-9]{32,32}$

device

object

required

tag

object

required

checkInstitute

object

required

docName

enum<string>

required

Allowed value:

PAN

type

enum<string>

required

Allowed values:

SOLE PROPBOIAOPHUFCOMPANYLLPPARTNERSHIP FIRMTRUSTGOVERNEMNT AGENCYLOCAL AUTHORITYAJP

value

string

required

Match pattern:

^[a-zA-Z0-9]{50}$

registeredName

string

required

>= 1 characters<= 256 characters

Match pattern:

^([^\\\"])*$

Example

{
    "initiatorEntity": "string",
    "objectId": "string",
    "device": {
        "tag": {
            "name": "GEOCODE",
            "value": "string"
        }
    },
    "checkInstitute": {
        "docName": "PAN",
        "type": "SOLE PROP",
        "value": "string",
        "registeredName": "string"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v0/business-onboarding/reg-check-entity' \
--header 'Content-Type: application/json' \
--data-raw '{
    "initiatorEntity": "string",
    "objectId": "string",
    "device": {
        "tag": {
            "name": "GEOCODE",
            "value": "string"
        }
    },
    "checkInstitute": {
        "docName": "PAN",
        "type": "SOLE PROP",
        "value": "string",
        "registeredName": "string"
    }
}'

Responses

🟢200Success

application/json

Body

payload

string

required

response_code

integer

required

response_message

string

required

Example

{
  "payload": "SUCCESS",
  "response_code": 0,
  "response_message": "SUCCESS"
}

Modified at 2025-07-05 16:11:16

Business Onboarding