Accounts API
9 endpoints
POST
/api/v01/accounts/create/base
Create a base fiat (INR) account for a user.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| user.item | string | no | User item ID (one of item/mail/mobile/nuvo required) |
| user.mail | string | no | User email address |
| user.mobile.code | string | no | Mobile country code |
| user.mobile.number | string | no | Mobile number |
| user.nuvo | string | no | User nuvo number |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| user | object | no | { name, nuvo, item } |
| account | object | no | { name, number, link } |
| balance | object | no | { number, ticker } |
| network | object | no | { name, number, link } |
| active | boolean | no | Active status |
| item | string | no | Account item ID |
| created | number | no | Creation timestamp (ms) |
Request Payload
accounts/create/base
{
"data": {
"user": {
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
}
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
201 Created
{
"data": {
"user": {
"name": "Alice Patel",
"nuvo": "4412309876543210",
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"account": {
"name": "INR Account",
"number": "NUVO000001INR",
"link": null
},
"balance": {
"number": "0.000000",
"ticker": "INR"
},
"network": {
"name": "Nuvo",
"number": "1",
"link": null
},
"active": true,
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
"created": 1700001000000
},
"memo": "Account created.",
"stat": true,
"code": 201,
"time": 1700001000018,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}404 — User not found
{
"data": {},
"memo": "User not found.",
"stat": false,
"code": 404,
"time": 1700001000040,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Already exists
{
"data": {},
"memo": "Account already exists with same item or account number.",
"stat": false,
"code": 409,
"time": 1700001000061,
"trxn": "e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/accounts/create/webx
Create a Web3 wallet account on a supported blockchain network.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| user.item | string | no | User item ID (one of item/mail/mobile/nuvo required) |
| network.code | string | yes | Network code (e.g. 'polygon', 'solana', 'xrpl') |
| account.name | string | no | Account display name |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| user | object | no | { name, nuvo, item } |
| account | object | no | { name, number (wallet address), link } |
| balance | object | no | { number, ticker } |
| network | object | no | { name, number, link } |
| active | boolean | no | Active status |
| item | string | no | Account item ID |
| created | number | no | Creation timestamp (ms) |
Request Payload
accounts/create/webx
{
"data": {
"user": {
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"network": {
"code": "polygon"
},
"account": {
"name": "My Polygon Wallet"
}
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
201 Created
{
"data": {
"user": {
"name": "Alice Patel",
"nuvo": "4412309876543210",
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"account": {
"name": "My Polygon Wallet",
"number": "0x4a8b3c2d1e0f9a8b7c6d5e4f3a2b1c0d",
"link": null
},
"balance": {
"number": "0.000000",
"ticker": "MATIC"
},
"network": {
"name": "Polygon",
"number": "137",
"link": "https://polygonscan.com"
},
"active": true,
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
"created": 1700001100000
},
"memo": "Wallet created.",
"stat": true,
"code": 201,
"time": 1700001100022,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}404 — Invalid network
{
"data": {},
"memo": "Invalid or inactive network code.",
"stat": false,
"code": 404,
"time": 1700001100045,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}422 — Wallet generation failed
{
"data": {},
"memo": "Unable to generate wallet.",
"stat": false,
"code": 422,
"time": 1700001100067,
"trxn": "e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/accounts/details
Fetch account details by item ID or account number.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | no | Account item ID (one of item or nmbr required) |
| nmbr | string | no | Account number |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| user | object | no | { name, nuvo, item } |
| account | object | no | { name, number, link } |
| balance | object | no | { number, ticker } |
| network | object | no | { name, number, link } |
| locked | boolean | no | Whether account is locked |
| active | boolean | no | Active status |
| item | string | no | Account item ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
accounts/details
{
"data": {
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"user": {
"name": "Alice Patel",
"nuvo": "4412309876543210",
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"account": {
"name": "INR Account",
"number": "NUVO000001INR",
"link": null
},
"balance": {
"number": "1500.000000",
"ticker": "INR"
},
"network": {
"name": "Nuvo",
"number": "1",
"link": null
},
"locked": false,
"active": true,
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
"created": 1700001000000,
"modified": 1700001000000
},
"memo": "Account found.",
"stat": true,
"code": 200,
"time": 1700001200014,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}404 — Not found
{
"data": {},
"memo": "Account not found.",
"stat": false,
"code": 404,
"time": 1700001200036,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/accounts/balance
Fetch live balance. Web3 accounts fetch from chain; base accounts return stored balance.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | no | Account item ID (one of item or nmbr required) |
| nmbr | string | no | Account number |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| user | object | no | { name, nuvo, item } |
| account | object | no | { name, number, link } |
| balance | object | no | { number, ticker } |
| network | object | no | { name, number, link } |
| locked | boolean | no | Whether account is locked |
| active | boolean | no | Active status |
| item | string | no | Account item ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
accounts/balance
{
"data": {
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"user": {
"name": "Alice Patel",
"nuvo": "4412309876543210",
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"account": {
"name": "INR Account",
"number": "NUVO000001INR",
"link": null
},
"balance": {
"number": "2500.000000",
"ticker": "INR"
},
"network": {
"name": "Nuvo",
"number": "1",
"link": null
},
"locked": false,
"active": true,
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
"created": 1700001000000,
"modified": 1700001300000
},
"memo": "Balance fetched.",
"stat": true,
"code": 200,
"time": 1700001300011,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Account inactive
{
"data": {},
"memo": "Account is inactive.",
"stat": false,
"code": 409,
"time": 1700001300033,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/accounts/balance/set
Manually credit or debit the stored balance of a base account.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | no | Account item ID (one of item or nmbr required) |
| nmbr | string | no | Account number |
| amount.number | string | yes | Positive decimal amount |
| amount.ticker | string | no | Token ticker (optional) |
| mode | string | yes | 'credit' or 'debit' |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| user | object | no | { name, nuvo, item } |
| account | object | no | { name, number, link } |
| balanceold | object | no | Previous balance { number, ticker } |
| balance | object | no | New balance { number, ticker } |
| network | object | no | { name, number, link } |
| active | boolean | no | Active status |
| item | string | no | Account item ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
accounts/balance/set
{
"data": {
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
"amount": {
"number": "500.000000"
},
"mode": "credit"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"user": {
"name": "Alice Patel",
"nuvo": "4412309876543210",
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"account": {
"name": "INR Account",
"number": "NUVO000001INR",
"link": null
},
"balanceold": {
"number": "2500.000000",
"ticker": "INR"
},
"balance": {
"number": "3000.000000",
"ticker": "INR"
},
"network": {
"name": "Nuvo",
"number": "1",
"link": null
},
"active": true,
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
"created": 1700001000000,
"modified": 1700001400000
},
"memo": "Balance updated.",
"stat": true,
"code": 200,
"time": 1700001400009,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Insufficient balance
{
"data": {},
"memo": "Insufficient balance for debit.",
"stat": false,
"code": 409,
"time": 1700001400031,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/accounts/lock
Lock an account to prevent transfers.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | no | Account item ID (one of item or nmbr required) |
| nmbr | string | no | Account number |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| user | object | no | { name, nuvo, item } |
| account | object | no | { name, number, link } |
| network | object | no | { name, number, link } |
| locked | boolean | no | true after lock |
| active | boolean | no | Active status |
| item | string | no | Account item ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
accounts/lock
{
"data": {
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"user": {
"name": "Alice Patel",
"nuvo": "4412309876543210",
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"account": {
"name": "INR Account",
"number": "NUVO000001INR",
"link": null
},
"network": {
"name": "Nuvo",
"number": "1",
"link": null
},
"locked": true,
"active": true,
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
"created": 1700001000000,
"modified": 1700001500000
},
"memo": "Account locked.",
"stat": true,
"code": 200,
"time": 1700001500007,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Already locked
{
"data": {},
"memo": "Account already locked.",
"stat": false,
"code": 409,
"time": 1700001500029,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/accounts/unlock
Unlock a previously locked account.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | no | Account item ID (one of item or nmbr required) |
| nmbr | string | no | Account number |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| user | object | no | { name, nuvo, item } |
| account | object | no | { name, number, link } |
| network | object | no | { name, number, link } |
| locked | boolean | no | false after unlock |
| active | boolean | no | Active status |
| item | string | no | Account item ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
accounts/unlock
{
"data": {
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"user": {
"name": "Alice Patel",
"nuvo": "4412309876543210",
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"account": {
"name": "INR Account",
"number": "NUVO000001INR",
"link": null
},
"network": {
"name": "Nuvo",
"number": "1",
"link": null
},
"locked": false,
"active": true,
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
"created": 1700001000000,
"modified": 1700001600000
},
"memo": "Account unlocked.",
"stat": true,
"code": 200,
"time": 1700001600013,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Already unlocked
{
"data": {},
"memo": "Account already unlocked.",
"stat": false,
"code": 409,
"time": 1700001600035,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/accounts/list/user
List all accounts belonging to a user.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| user.item | string | no | User item ID (one of item/nuvo/mail/mobile required) |
| user.nuvo | string | no | User nuvo number |
| user.mail | string | no | User email address |
| page | number | no | Page number (default: 1) |
| limit | number | no | Per page (default: 25, max: 100) |
| actv | boolean | no | Filter by active status |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| accounts | array | no | Array of account objects |
| page | number | no | Current page |
| limit | number | no | Items per page |
| total | number | no | Total account count |
| pages | number | no | Total pages |
Request Payload
accounts/list/user
{
"data": {
"user": {
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"page": 1,
"limit": 20
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"accounts": [
{
"account": {
"name": "INR Account",
"number": "NUVO000001INR",
"link": null
},
"balance": {
"number": "3000.000000",
"ticker": "INR"
},
"network": {
"name": "Nuvo",
"number": "1",
"link": null
},
"locked": false,
"active": true,
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
"created": 1700001000000
},
{
"account": {
"name": "My Polygon Wallet",
"number": "0x4a8b3c2d1e0f9a8b7c6d5e4f3a2b1c0d",
"link": null
},
"balance": {
"number": "0.000000",
"ticker": "MATIC"
},
"network": {
"name": "Polygon",
"number": "137",
"link": "https://polygonscan.com"
},
"locked": false,
"active": true,
"item": "b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8",
"created": 1700001100000
}
],
"page": 1,
"limit": 20,
"total": 2,
"pages": 1
},
"memo": "Accounts found.",
"stat": true,
"code": 200,
"time": 1700001700016,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}404 — User identifier required
{
"data": {},
"memo": "Provide user identifier in data.user (item/nuvo/mail/mobile).",
"stat": false,
"code": 404,
"time": 1700001700038,
"trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}POST
/api/v01/accounts/delete
Soft-delete an account.
Request payload (inside encrypted data {})
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | no | Account item ID (one of item or nmbr required) |
| nmbr | string | no | Account number |
Response data {}
| Field | Type | Required | Description |
|---|---|---|---|
| user | object | no | { name, nuvo, item } |
| account | object | no | { name, number, link } |
| network | object | no | { name, number, link } |
| active | boolean | no | false after deletion |
| item | string | no | Account item ID |
| created | number | no | Creation timestamp (ms) |
| modified | number | no | Last modified timestamp (ms) |
Request Payload
accounts/delete
{
"data": {
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7"
},
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}Response Data
200 OK
{
"data": {
"user": {
"name": "Alice Patel",
"nuvo": "4412309876543210",
"item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
},
"account": {
"name": "INR Account",
"number": "NUVO000001INR",
"link": null
},
"network": {
"name": "Nuvo",
"number": "1",
"link": null
},
"active": false,
"item": "a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7",
"created": 1700001000000,
"modified": 1700001800000
},
"memo": "Account deleted.",
"stat": true,
"code": 200,
"time": 1700001800010,
"trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}409 — Already inactive
{
"data": {},
"memo": "Account already inactive.",
"stat": false,
"code": 409,
"time": 1700001800032,
"trxn": "e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
"srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}