Users API

6 endpoints

POST

/api/v01/users/create

Create a new user. Requires at least one of email or mobile.

Request payload (inside encrypted data {})

Field	Type	Required	Description
name	string	yes	Full name
mail	string	no	Email address (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	User display name
mail	string	no	Email address
mobile	string	no	Mobile in code.number format
nuvo	string	no	Nuvo wallet number
active	boolean	no	Account status
item	string	no	Created user ID
created	number	no	Creation timestamp (ms)
modified	number	no	Last modified timestamp (ms)

Request Payload

Request data

{
  "data": {
    "name": "Jane Smith",
    "mail": "jane@example.com",
    "mobile": {
      "code": "91",
      "number": "9876543210"
    }
  },
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

Response Data

201 Created

{
  "data": {
    "name": "Jane Smith",
    "mail": "jane@example.com",
    "mobile": "91.9876543210",
    "nuvo": "9123456789012345",
    "active": true,
    "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5",
    "created": 1700000000000,
    "modified": 1700000000000
  },
  "memo": "User created successfully.",
  "stat": true,
  "code": 201,
  "time": 48,
  "trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

400 Bad Request — name missing

{
  "data": {},
  "memo": "name is required.",
  "stat": false,
  "code": 400,
  "time": 8,
  "trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

409 Conflict — email already registered

{
  "data": {},
  "memo": "User with same email or mobile already exists.",
  "stat": false,
  "code": 409,
  "time": 14,
  "trxn": "e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

POST

/api/v01/users/details

Fetch full details for a user by their item ID.

Request payload (inside encrypted data {})

Field	Type	Required	Description
user	string	yes	User item ID

Response data {}

Field	Type	Required	Description
name	string	no	Display name
mail	string	no	Email
mobile	string	no	Mobile in code.number format
nuvo	string	no	Nuvo number
avatar	object	no	{ link, mime } — avatar image
wall	object	no	{ link, mime } — background image
sort	string	no	Always 'user'
active	boolean	no	Account status
item	string	no	User ID
created	number	no	Creation timestamp (ms)
modified	number	no	Last modified timestamp (ms)

Request Payload

Request data

{
  "data": {
    "user": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
  },
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

Response Data

200 OK

{
  "data": {
    "name": "Jane Smith",
    "mail": "jane@example.com",
    "mobile": "91.9876543210",
    "nuvo": "9123456789012345",
    "avatar": null,
    "wall": null,
    "sort": "user",
    "active": true,
    "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5",
    "created": 1700000000000,
    "modified": 1700000000000
  },
  "memo": "User found.",
  "stat": true,
  "code": 200,
  "time": 22,
  "trxn": "f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

404 Not Found

{
  "data": {},
  "memo": "User not found.",
  "stat": false,
  "code": 404,
  "time": 11,
  "trxn": "a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

POST

/api/v01/users/delete

Soft-delete a user (sets active: false). Provide one identifier.

Request payload (inside encrypted data {})

Field	Type	Required	Description
item	string	no	User item ID
nuvo	string	no	Nuvo number
mail	string	no	Email address
mobile.code	string	no	Country code
mobile.number	string	no	Phone number digits

Response data {}

Field	Type	Required	Description
name	string	no	User display name
mail	string	no	Email
mobile	string	no	Mobile in code.number format
nuvo	string	no	Nuvo number
sort	string	no	'user'
active	boolean	no	false after deletion
item	string	no	User ID
created	number	no	Creation timestamp (ms)
modified	number	no	Deletion timestamp (ms)

Request Payload

Request data

{
  "data": {
    "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
  },
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

Response Data

200 OK

{
  "data": {
    "name": "Jane Smith",
    "mail": "jane@example.com",
    "mobile": "91.9876543210",
    "nuvo": "9123456789012345",
    "sort": "user",
    "active": false,
    "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5",
    "created": 1700000000000,
    "modified": 1700100000000
  },
  "memo": "User deleted.",
  "stat": true,
  "code": 200,
  "time": 19,
  "trxn": "b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

404 Not Found

{
  "data": {},
  "memo": "User not found.",
  "stat": false,
  "code": 404,
  "time": 10,
  "trxn": "c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

409 Conflict — already inactive

{
  "data": {},
  "memo": "User already inactive.",
  "stat": false,
  "code": 409,
  "time": 9,
  "trxn": "d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

POST

/api/v01/users/list

Paginated list of users. Supports name search.

Request payload (inside encrypted data {})

Field	Type	Required	Description
query	string	no	Name search query
actv	boolean	no	Filter by active status (default: true)
page	number	no	Page number (default: 1)
limit	number	no	Results per page (default: 25, max: 100)

Response data {}

Field	Type	Required	Description
users	array	no	Array of user 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": "Jane",
    "page": 1,
    "limit": 20
  },
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

Response Data

200 OK

{
  "data": {
    "users": [
      {
        "name": "Jane Smith",
        "mail": "jane@example.com",
        "mobile": "91.9876543210",
        "nuvo": "9123456789012345",
        "active": true,
        "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5",
        "created": 1700000000000,
        "modified": 1700000000000
      }
    ],
    "page": 1,
    "limit": 20,
    "total": 1,
    "pages": 1
  },
  "memo": "Users found.",
  "stat": true,
  "code": 200,
  "time": 35,
  "trxn": "e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

POST

/api/v01/users/accounts

Get all accounts and team/business memberships associated with a user.

Request payload (inside encrypted data {})

Field	Type	Required	Description
user	string	yes	User item ID

Response data {}

Field	Type	Required	Description
list	array	no	Array of account/membership objects with sort ('user' \| 'business'), role, menu, active, item

Request Payload

Request data

{
  "data": {
    "user": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
  },
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

Response Data

200 OK

{
  "data": {
    "list": [
      {
        "name": "Jane Smith",
        "nuvo": "9123456789012345",
        "sort": "user",
        "role": "member",
        "menu": [],
        "active": true,
        "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
      },
      {
        "name": "Acme Corp",
        "nuvo": "9876543210123456",
        "sort": "business",
        "role": "admin",
        "menu": [
          "orders",
          "transfers"
        ],
        "active": true,
        "item": "d9e0f1a2b3c4d5e6a7b8c9d0e1f2a3b4"
      }
    ]
  },
  "memo": "Accounts found.",
  "stat": true,
  "code": 200,
  "time": 28,
  "trxn": "f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

404 Not Found

{
  "data": {},
  "memo": "User not found.",
  "stat": false,
  "code": 404,
  "time": 12,
  "trxn": "a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

POST

/api/v01/users/avatar/set

Update the avatar image for a user. Accepts a public image URL (jpg/png).

Request payload (inside encrypted data {})

Field	Type	Required	Description
identifier	object	yes	One of: { item }, { nuvo }, { mail }, { mobile: { code, number } }
media.link	string	yes	Public https URL to image (jpg or png)
media.mime	string	no	image/jpeg or image/png

Response data {}

Field	Type	Required	Description
name	string	no	User display name
avatar.link	string	no	Avatar URL
avatar.mime	string	no	MIME type
item	string	no	User ID
modified	number	no	Updated timestamp (ms)

Request Payload

Request data

{
  "data": {
    "identifier": {
      "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
    },
    "media": {
      "link": "https://cdn.example.com/avatars/jane.png",
      "mime": "image/png"
    }
  },
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

Response Data

200 OK

{
  "data": {
    "name": "Jane Smith",
    "avatar": {
      "link": "https://cdn.example.com/avatars/jane.png",
      "mime": "image/png"
    },
    "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5",
    "modified": 1700100000000
  },
  "memo": "Avatar updated.",
  "stat": true,
  "code": 200,
  "time": 41,
  "trxn": "b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

404 Not Found

{
  "data": {},
  "memo": "User not found.",
  "stat": false,
  "code": 404,
  "time": 13,
  "trxn": "c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

404 Bad Media — invalid URL or file type

{
  "data": {},
  "memo": "Only jpg, jpeg, png are allowed.",
  "stat": false,
  "code": 404,
  "time": 7,
  "trxn": "d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

← Back to API Reference Next: Business →

Users API

6 endpoints

POST

/api/v01/users/create

Create a new user. Requires at least one of email or mobile.

Request payload (inside encrypted data {})

Field	Type	Required	Description
name	string	yes	Full name
mail	string	no	Email address (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	User display name
mail	string	no	Email address
mobile	string	no	Mobile in code.number format
nuvo	string	no	Nuvo wallet number
active	boolean	no	Account status
item	string	no	Created user ID
created	number	no	Creation timestamp (ms)
modified	number	no	Last modified timestamp (ms)

Request Payload

Request data

{
  "data": {
    "name": "Jane Smith",
    "mail": "jane@example.com",
    "mobile": {
      "code": "91",
      "number": "9876543210"
    }
  },
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

Response Data

201 Created

{
  "data": {
    "name": "Jane Smith",
    "mail": "jane@example.com",
    "mobile": "91.9876543210",
    "nuvo": "9123456789012345",
    "active": true,
    "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5",
    "created": 1700000000000,
    "modified": 1700000000000
  },
  "memo": "User created successfully.",
  "stat": true,
  "code": 201,
  "time": 48,
  "trxn": "a3f2c1b4d5e6f7a8b9c0d1e2f3a4b5c6",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

400 Bad Request — name missing

{
  "data": {},
  "memo": "name is required.",
  "stat": false,
  "code": 400,
  "time": 8,
  "trxn": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

409 Conflict — email already registered

{
  "data": {},
  "memo": "User with same email or mobile already exists.",
  "stat": false,
  "code": 409,
  "time": 14,
  "trxn": "e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

POST

/api/v01/users/details

Fetch full details for a user by their item ID.

Request payload (inside encrypted data {})

Field	Type	Required	Description
user	string	yes	User item ID

Response data {}

Field	Type	Required	Description
name	string	no	Display name
mail	string	no	Email
mobile	string	no	Mobile in code.number format
nuvo	string	no	Nuvo number
avatar	object	no	{ link, mime } — avatar image
wall	object	no	{ link, mime } — background image
sort	string	no	Always 'user'
active	boolean	no	Account status
item	string	no	User ID
created	number	no	Creation timestamp (ms)
modified	number	no	Last modified timestamp (ms)

Request Payload

Request data

{
  "data": {
    "user": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
  },
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

Response Data

200 OK

{
  "data": {
    "name": "Jane Smith",
    "mail": "jane@example.com",
    "mobile": "91.9876543210",
    "nuvo": "9123456789012345",
    "avatar": null,
    "wall": null,
    "sort": "user",
    "active": true,
    "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5",
    "created": 1700000000000,
    "modified": 1700000000000
  },
  "memo": "User found.",
  "stat": true,
  "code": 200,
  "time": 22,
  "trxn": "f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

404 Not Found

{
  "data": {},
  "memo": "User not found.",
  "stat": false,
  "code": 404,
  "time": 11,
  "trxn": "a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

POST

/api/v01/users/delete

Soft-delete a user (sets active: false). Provide one identifier.

Request payload (inside encrypted data {})

Field	Type	Required	Description
item	string	no	User item ID
nuvo	string	no	Nuvo number
mail	string	no	Email address
mobile.code	string	no	Country code
mobile.number	string	no	Phone number digits

Response data {}

Field	Type	Required	Description
name	string	no	User display name
mail	string	no	Email
mobile	string	no	Mobile in code.number format
nuvo	string	no	Nuvo number
sort	string	no	'user'
active	boolean	no	false after deletion
item	string	no	User ID
created	number	no	Creation timestamp (ms)
modified	number	no	Deletion timestamp (ms)

Request Payload

Request data

{
  "data": {
    "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
  },
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

Response Data

200 OK

{
  "data": {
    "name": "Jane Smith",
    "mail": "jane@example.com",
    "mobile": "91.9876543210",
    "nuvo": "9123456789012345",
    "sort": "user",
    "active": false,
    "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5",
    "created": 1700000000000,
    "modified": 1700100000000
  },
  "memo": "User deleted.",
  "stat": true,
  "code": 200,
  "time": 19,
  "trxn": "b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

404 Not Found

{
  "data": {},
  "memo": "User not found.",
  "stat": false,
  "code": 404,
  "time": 10,
  "trxn": "c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

409 Conflict — already inactive

{
  "data": {},
  "memo": "User already inactive.",
  "stat": false,
  "code": 409,
  "time": 9,
  "trxn": "d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

POST

/api/v01/users/list

Paginated list of users. Supports name search.

Request payload (inside encrypted data {})

Field	Type	Required	Description
query	string	no	Name search query
actv	boolean	no	Filter by active status (default: true)
page	number	no	Page number (default: 1)
limit	number	no	Results per page (default: 25, max: 100)

Response data {}

Field	Type	Required	Description
users	array	no	Array of user 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": "Jane",
    "page": 1,
    "limit": 20
  },
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

Response Data

200 OK

{
  "data": {
    "users": [
      {
        "name": "Jane Smith",
        "mail": "jane@example.com",
        "mobile": "91.9876543210",
        "nuvo": "9123456789012345",
        "active": true,
        "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5",
        "created": 1700000000000,
        "modified": 1700000000000
      }
    ],
    "page": 1,
    "limit": 20,
    "total": 1,
    "pages": 1
  },
  "memo": "Users found.",
  "stat": true,
  "code": 200,
  "time": 35,
  "trxn": "e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

POST

/api/v01/users/accounts

Get all accounts and team/business memberships associated with a user.

Request payload (inside encrypted data {})

Field	Type	Required	Description
user	string	yes	User item ID

Response data {}

Field	Type	Required	Description
list	array	no	Array of account/membership objects with sort ('user' \| 'business'), role, menu, active, item

Request Payload

Request data

{
  "data": {
    "user": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
  },
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

Response Data

200 OK

{
  "data": {
    "list": [
      {
        "name": "Jane Smith",
        "nuvo": "9123456789012345",
        "sort": "user",
        "role": "member",
        "menu": [],
        "active": true,
        "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
      },
      {
        "name": "Acme Corp",
        "nuvo": "9876543210123456",
        "sort": "business",
        "role": "admin",
        "menu": [
          "orders",
          "transfers"
        ],
        "active": true,
        "item": "d9e0f1a2b3c4d5e6a7b8c9d0e1f2a3b4"
      }
    ]
  },
  "memo": "Accounts found.",
  "stat": true,
  "code": 200,
  "time": 28,
  "trxn": "f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

404 Not Found

{
  "data": {},
  "memo": "User not found.",
  "stat": false,
  "code": 404,
  "time": 12,
  "trxn": "a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

POST

/api/v01/users/avatar/set

Update the avatar image for a user. Accepts a public image URL (jpg/png).

Request payload (inside encrypted data {})

Field	Type	Required	Description
identifier	object	yes	One of: { item }, { nuvo }, { mail }, { mobile: { code, number } }
media.link	string	yes	Public https URL to image (jpg or png)
media.mime	string	no	image/jpeg or image/png

Response data {}

Field	Type	Required	Description
name	string	no	User display name
avatar.link	string	no	Avatar URL
avatar.mime	string	no	MIME type
item	string	no	User ID
modified	number	no	Updated timestamp (ms)

Request Payload

Request data

{
  "data": {
    "identifier": {
      "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5"
    },
    "media": {
      "link": "https://cdn.example.com/avatars/jane.png",
      "mime": "image/png"
    }
  },
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

Response Data

200 OK

{
  "data": {
    "name": "Jane Smith",
    "avatar": {
      "link": "https://cdn.example.com/avatars/jane.png",
      "mime": "image/png"
    },
    "item": "c8f3a2b1d4e5f6a7b8c9d0e1f2a3b4c5",
    "modified": 1700100000000
  },
  "memo": "Avatar updated.",
  "stat": true,
  "code": 200,
  "time": 41,
  "trxn": "b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

404 Not Found

{
  "data": {},
  "memo": "User not found.",
  "stat": false,
  "code": 404,
  "time": 13,
  "trxn": "c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

404 Bad Media — invalid URL or file type

{
  "data": {},
  "memo": "Only jpg, jpeg, png are allowed.",
  "stat": false,
  "code": 404,
  "time": 7,
  "trxn": "d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1",
  "srvc": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6"
}

← Back to API Reference Next: Business →