Business API
5 endpoints
POST
/api/v01/business/create
Create a new business entity. Requires at least one of email or mobile.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Business display name |
| string | no | Business email (one of mail or mobile required) | |
| mobile.code | string | no | Country code, e.g. '91' |
| mobile.number | string | no | Phone number digits |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | no | Business display name |
| string | no | Email address | |
| mobile | string | no | Mobile in code.number format |
| nuvo | string | no | Nuvo wallet number |
| sort | string | no | Entity type — always 'business' |
| active | boolean | no | Account status |
| item | string | no | Created business ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
Request data
{
"data": {
"name": "Acme Corp",
"mail": "hello@acme.com",
"mobile": {
"code": "91",
"number": "9000000001"
}
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
201 Created
{
"data": {
"name": "Acme Corp",
"mail": "hello@acme.com",
"mobile": "91.9000000001",
"nuvo": "8234567890123456",
"sort": "business",
"active": true,
"item": "d9e0f1a2b3c4d5e6a7b8c9d0e1f2a3b4",
"created": 1700000000000,
"modified": 1700000000000
},
"memo": "Business created successfully.",
"stat": true,
"code": 201,
"time": 52,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 Conflict — email or mobile already registered
{
"data": {},
"memo": "Business with same email or mobile already exists.",
"stat": false,
"code": 409,
"time": 11,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/business/details
Fetch details for a specific business by its item ID.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | yes | Business item ID |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | no | Business display name |
| string | no | Email address | |
| mobile | string | no | Mobile in code.number format |
| nuvo | string | no | Nuvo wallet number |
| avatar | object | no | Avatar object { link, mime } or null |
| wall | object | no | Wall/cover image object or null |
| sort | string | no | Entity type — always 'business' |
| active | boolean | no | Account status |
| item | string | no | Business ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
Request data
{
"data": {
"item": "d9e0f1a2b3c4d5e6a7b8c9d0e1f2a3b4"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"name": "Acme Corp",
"mail": "hello@acme.com",
"mobile": "91.9000000001",
"nuvo": "8234567890123456",
"avatar": null,
"wall": null,
"sort": "business",
"active": true,
"item": "d9e0f1a2b3c4d5e6a7b8c9d0e1f2a3b4",
"created": 1700000000000,
"modified": 1700000000000
},
"memo": "Business found.",
"stat": true,
"code": 200,
"time": 34,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}404 Not Found
{
"data": {},
"memo": "Business not found.",
"stat": false,
"code": 404,
"time": 9,
"trxn": "e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/business/delete
Soft-delete a business (sets active: false).
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | yes | Business item ID |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | no | Business display name |
| string | no | Email address | |
| mobile | string | no | Mobile in code.number format |
| nuvo | string | no | Nuvo wallet number |
| sort | string | no | Entity type — always 'business' |
| active | boolean | no | false after deletion |
| item | string | no | Business ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
Request data
{
"data": {
"item": "d9e0f1a2b3c4d5e6a7b8c9d0e1f2a3b4"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK — business deleted
{
"data": {
"name": "Acme Corp",
"mail": "hello@acme.com",
"mobile": "91.9000000001",
"nuvo": "8234567890123456",
"sort": "business",
"active": false,
"item": "d9e0f1a2b3c4d5e6a7b8c9d0e1f2a3b4",
"created": 1700000000000,
"modified": 1700003600000
},
"memo": "Business deleted.",
"stat": true,
"code": 200,
"time": 27,
"trxn": "e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 Conflict — already inactive
{
"data": {},
"memo": "Business already inactive.",
"stat": false,
"code": 409,
"time": 8,
"trxn": "f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/business/list
Paginated list of businesses. Supports name search.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| page | number | no | Page number (default: 1) |
| limit | number | no | Results per page (default: 25, max: 100) |
| actv | boolean | no | Filter by active status |
| query | string | no | Search string matched against business name |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| list | array | no | Array of business objects |
| page | number | no | Current page |
| limit | number | no | Items per page |
| total | number | no | Total matching records |
| pages | number | no | Total pages |
Request Payload
Request data
{
"data": {
"query": "Acme",
"page": 1,
"limit": 20
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"list": [
{
"name": "Acme Corp",
"mail": "hello@acme.com",
"mobile": "91.9000000001",
"nuvo": "8234567890123456",
"sort": "business",
"active": true,
"item": "d9e0f1a2b3c4d5e6a7b8c9d0e1f2a3b4",
"created": 1700000000000,
"modified": 1700000000000
}
],
"page": 1,
"limit": 20,
"total": 1,
"pages": 1
},
"memo": "Businesses found.",
"stat": true,
"code": 200,
"time": 41,
"trxn": "f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/business/avatar/set
Update the avatar image for a business.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | yes | Business item ID |
| media.link | string | yes | Public https URL to image (jpg/png) |
| media.mime | string | no | MIME type, e.g. image/png |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | no | Business name |
| avatar.link | string | no | Avatar URL |
| avatar.mime | string | no | MIME type |
| item | string | no | Business ID |
| modified | number | no | Updated timestamp (ms) |
Request Payload
Request data
{
"data": {
"item": "d9e0f1a2b3c4d5e6a7b8c9d0e1f2a3b4",
"media": {
"link": "https://cdn.example.com/logo.png",
"mime": "image/png"
}
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK — avatar updated
{
"data": {
"name": "Acme Corp",
"avatar": {
"link": "https://cdn.example.com/logo.png",
"mime": "image/png"
},
"item": "d9e0f1a2b3c4d5e6a7b8c9d0e1f2a3b4",
"modified": 1700007200000
},
"memo": "Avatar updated.",
"stat": true,
"code": 200,
"time": 38,
"trxn": "a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}404 Not Found
{
"data": {},
"memo": "Business not found.",
"stat": false,
"code": 404,
"time": 7,
"trxn": "b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}