🚀 VaultsPay API v1 is live. See what's new →
UsersOverview

Users

A User represents an end customer of your SaaS application. Users are the parent entity that owns Accounts and Payment Cards.

The User object

{
  "id": "usr_01HX71YM6FJ3A8W7T5K6NRB2DN",
  "object": "user",
  "email": "ali@example.com",
  "mobile": "+971501234567",
  "first_name": "Ali",
  "last_name": "Hassan",
  "date_of_birth": "1993-05-14",
  "nationality": "AE",
  "address": {
    "line1": "Sheikh Zayed Road, Tower 3, Apt 1205",
    "city": "Dubai",
    "country": "AE",
    "postal_code": "00000"
  },
  "kyc": {
    "status": "approved",
    "level": "full",
    "approved_at": "2026-04-20T09:15:22Z"
  },
  "status": "active",
  "created_at": "2026-04-19T12:04:00Z"
}

Lifecycle

  1. Create the user with minimal details (email, name, mobile).
  2. Upload KYC documents (Emirates ID, passport, address proof).
  3. KYC verification runs automatically. Webhooks notify you of progress.
  4. On approval, you can open accounts, issue cards, and transact.
  5. You may suspend, reactivate, or delete a user at any time.

Endpoints