Enkash Developer Portal
Home
Home
Login
  1. Business Onboarding
  • Back to home
  • Vendor Payment
  • APIs
    • Business Onboarding
      • Initiate Entity Check
        POST
      • Register Entity
        POST
      • Bharat Connect B2B ID Registration
        POST
      • Search Entity
        POST
    • Invoice
      • Create Invoice
      • Confirm Invoice
      • Change Invoice Status
      • Edit Invoice
    • Payment
      • Pay Invoice
      • Payment Confirmation
    • Purchase Order
      • Send Purchase Order Request
      • Confirm Purchase Order
      • Edit Purchase Order
      • Change Purchase Order Status
    • Credit Note
      • Send C/N Request
      • Confirm C/N Request
      • Status Change C/N Request
    • Financing
      • Request Financing
      • Share Bid
      • Respond To Bid
  • Webhook
    • Business Onboarding
      • Check Entity Webhook
      • Entity Registration Response Webhook
      • Search Entity Response Webhook
      • Registration ID Response Webhook
    • Invoice
      • Create Invoice Request Webhook
      • Create Invoice Response Webhook
      • Confirm Invoice Request Webhook
      • Confirm Invoice Response Webhook
      • Status Change Invoice Request
      • Status Change Invoice Response Webhook
      • Edit Invoice Request Webhook
      • Edit Invoice Response Webhook
    • Payment
      • Payment Response Webhook
      • Payment Confirmation Response Webhook
      • Payment Request Webhook
      • Payment Confirmation Request Webhook
    • Credit Note
      • Send C/N RequestWebhook
      • Send C/N Response Webhook
      • Confirm C/N Request Webhook
      • Confirm C/N Response Webhook
      • Status Change C/N Request Webhook
      • Status Change C/N Response Webhook
    • Purchase Order
      • Send Purchase Order Request Webhook
      • Send Purchase Order Response Webhook
      • Confirm Purchase Order Request Webhook
      • Confirm Purchase Order Response Webhook
      • Edit Purchase Order Request Webhook
      • Edit Purchase Order Response Webhook
      • Status Change Purchase Order Request Webhook
      • Status Change Purchase Order Response Webhook
    • Financing
      • Financing Response Webhook
      • Respond Bid Response Webhook
      • Share Bid Request Webhook
  1. Business Onboarding

Search Entity

Developing
POST
/api/v0/business-onboarding/req-search-entity
📌
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.

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
onboardingB2BIds
object 
required
requestorB2BId
string 
required
Match pattern:
^([^\\\"]){1,100}$
search
object 
required
criteria
array [object {3}] 
required
Example
{
    "initiatorEntity": "string",
    "objectId": "string",
    "device": {
        "tag": {
            "name": "GEOCODE",
            "value": "string"
        }
    },
    "onboardingB2BIds": {
        "requestorB2BId": "string"
    },
    "search": {
        "criteria": [
            {
                "searchParameter": "GSTIN",
                "operator": "EXACT",
                "value": "string"
            }
        ]
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/v0/business-onboarding/req-search-entity' \
--header 'Content-Type: application/json' \
--data-raw '{
    "initiatorEntity": "string",
    "objectId": "string",
    "device": {
        "tag": {
            "name": "GEOCODE",
            "value": "string"
        }
    },
    "onboardingB2BIds": {
        "requestorB2BId": "string"
    },
    "search": {
        "criteria": [
            {
                "searchParameter": "GSTIN",
                "operator": "EXACT",
                "value": "string"
            }
        ]
    }
}'

Responses

🟢200Success
application/json
Body
response_code
integer 
required
response_message
string 
required
payload
string 
required
Example
{
  "response_code": 0,
  "response_message": "SUCCESS",
  "payload": "string"
}
Modified at 2025-07-05 16:17:53
Previous
Bharat Connect B2B ID Registration
Next
Create Invoice
Built with