- EnKash Developer Portal Overview
- Payment Gateway
- Payment Gateway Overview
- Payment Gateway Sign Up
- Payment Methods
- Supported Integrations
- Payment Gateway APIs
- Web Integration
- Server to Server Integration
- Test Card Details
- Authorization
- Orders
- Payments
- Refunds
- Settlements
- Split Settlements
- E-Commerce Plugins
- Payment Links
- Payment Button
- Qr Code
- UPI Mandate
- Payment Links
- Bharat Connect (BBPS)
- About Bharat Connect
- B2B Invoicing
- Invoice
- Payment
- Financing
- Onboarding
- cdNote
- Purchase Order
- webhook-invoice
- webhook-payments
- webhook-business-onboarding
- webhook-financing
- webhook-cdNote
- Webhook Purchase Order
- Webhook 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
- Bill Payments
- Payouts
- Accounts Payable Management Tool
- Account Receivable
- Expense Management
- Loyalty
- Card Management
- Verification Suite
Register Entity
POST
/api/v0/business-onboarding/reg-entity
Request
Body Params application/json
initiatorEntity
stringÂ
required
device
objectÂ
required
tag
objectÂ
required
institute
objectÂ
required
objectId
stringÂ
required
Match pattern:
^[ORG]{3}[A-Za-z0-9]{32,32}$
objectVersion
objectÂ
required
name
stringÂ
required
>= 1 characters<= 256 characters
Match pattern:
^([^\\\"])*$
alias
stringÂ
optional
defaultB2BId
stringÂ
required
mccCode
stringÂ
required
>= 4 characters<= 4 characters
lei
objectÂ
required
primaryBusinessIdentifier
objectÂ
required
otherBusinessIdentifiers
array [object {3}]Â
optional
addresses
array [object {7}]Â
required
bankAccounts
array [object {5}]Â
required
contactNumbers
array [object {3}]Â
required
emails
array[string]
optional
cin
stringÂ
optional
dins
array[string]
optional
primaryContactNumber
objectÂ
required
primaryEmail
stringÂ
required
Match pattern:
^[A-Za-z0-9+_.-]+@(.+)$
Example
{
"initiatorEntity": "string",
"device": {
"tag": {
"name": "GEOCODE",
"value": "string"
}
},
"institute": {
"objectId": "string",
"objectVersion": {
"currentVersion": 1,
"newVersion": 1
},
"name": "string",
"alias": "string",
"defaultB2BId": "string",
"mccCode": "stri",
"lei": {
"documentName": "PAN",
"type": "SOLE PROP",
"value": "string",
"registeredName": "string"
},
"primaryBusinessIdentifier": {
"documentName": "GSTIN",
"value": "string",
"registeredName": "string"
},
"otherBusinessIdentifiers": [
{
"documentName": "GSTIN",
"value": "string",
"registeredName": "string"
}
],
"addresses": [
{
"type": "REGISTERED ADDRESS",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "ANDAMAN AND NICOBAR ISLANDS",
"country": "INDIA",
"pincode": "string"
}
],
"bankAccounts": [
{
"businessVPA": "string",
"type": "SAVINGS",
"ifsc": "string",
"acNum": "string",
"beneficiaryName": "string"
}
],
"contactNumbers": [
{
"type": "MOBILE",
"countryCode": "string",
"phoneNumber": "string"
}
],
"emails": [
"string"
],
"cin": "string",
"dins": [
"string"
],
"primaryContactNumber": {
"type": "MOBILE",
"countryCode": "string",
"phoneNumber": "string"
},
"primaryEmail": "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/reg-entity' \
--header 'Content-Type: application/json' \
--data-raw ''
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 2024-10-10 08:29:16