Users

User management

Get all users

get

/api/v1/

/user

Retrieve list of all users

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Responses

200

Successfully retrieved list of users for the tenant

application/json

get

/user

HTTPcURLJavaScriptPython

GET /api/v1/user HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

200

Successfully retrieved list of users for the tenant

[
  {
    "id": "u1a2b3c4-d5e6-4f7a-8b9c-0d1e2f3a4b5c",
    "createdAt": "2025-10-01T09:00:00.000Z",
    "updatedAt": "2025-11-15T14:30:00.000Z",
    "deletedAt": null,
    "fullNames": "Thabo",
    "lastName": "Molefe",
    "dateOfBirth": "1990-05-15",
    "documentType": "national_id",
    "documentNumber": "9005155432089",
    "documentCountry": "South Africa",
    "documentExpiryDate": "2030-05-15",
    "mobileNumber": "[phone]",
    "isVerified": true,
    "tenantUid": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "azaId": "aza_987654321"
  },
  {
    "id": "u2b3c4d5-e6f7-4a8b-9c0d-1e2f3a4b5c6d",
    "createdAt": "2025-09-20T11:15:00.000Z",
    "updatedAt": "2025-11-10T16:45:00.000Z",
    "deletedAt": null,
    "fullNames": "Amina Nakato",
    "lastName": "Musoke",
    "dateOfBirth": "1985-08-22",
    "documentType": "passport",
    "documentNumber": "UG1234567",
    "documentCountry": "Uganda",
    "documentExpiryDate": "2028-08-22",
    "mobileNumber": "[phone]",
    "isVerified": true,
    "tenantUid": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "azaId": "aza_876543210"
  }
]

Create user

post

/api/v1/

/user

Create a new user

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Body

application/json

fullNamesstringRequired

User's full first and middle names

lastNamestringRequired

User's last name

dateOfBirthstringRequired

Date of birth in YYYY-MM-DD format

documentTypestringRequired

Type of identification document (e.g., passport, national_id)

documentNumberstringRequired

Identification document number

documentCountrystringRequired

Country that issued the document

documentExpiryDatestringRequired

Document expiry date in YYYY-MM-DD format

mobileNumberstringRequired

Mobile phone number in international E.164 format

Responses

201

User created successfully

application/json

400

Bad request - Invalid input data

application/json

401

Unauthorized - Invalid or missing API key

409

Conflict - User already exists

500

Internal server error

post

/user

HTTPcURLJavaScriptPython

POST /api/v1/user HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "fullNames": "text",
  "lastName": "text",
  "dateOfBirth": "text",
  "documentType": "text",
  "documentNumber": "text",
  "documentCountry": "text",
  "documentExpiryDate": "text",
  "mobileNumber": "text"
}

{
  "id": "text",
  "createdAt": "2025-12-12T09:19:18.580Z",
  "updatedAt": null,
  "deletedAt": null,
  "fullNames": "text",
  "lastName": "text",
  "dateOfBirth": "text",
  "documentType": "text",
  "documentNumber": "text",
  "documentCountry": "text",
  "documentExpiryDate": "text",
  "mobileNumber": "text",
  "isVerified": true,
  "tenantId": "text",
  "azaId": null
}

Get user by ID

get

/api/v1/

/user/{id}

Retrieve user by ID

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Path parameters

idstringRequired

Responses

200

Successfully retrieved user details

application/json

404

User not found

application/json

get

/user/{id}

HTTPcURLJavaScriptPython

GET /api/v1/user/{id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "u1a2b3c4-d5e6-4f7a-8b9c-0d1e2f3a4b5c",
  "createdAt": "2025-10-01T09:00:00.000Z",
  "updatedAt": "2025-11-15T14:30:00.000Z",
  "deletedAt": null,
  "fullNames": "Thabo",
  "lastName": "Molefe",
  "dateOfBirth": "1990-05-15",
  "documentType": "national_id",
  "documentNumber": "9005155432089",
  "documentCountry": "South Africa",
  "documentExpiryDate": "2030-05-15",
  "mobileNumber": "[phone]",
  "isVerified": true,
  "tenantUid": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "azaId": "aza_987654321"
}

Update user

put

/api/v1/

/user/{id}

Update user by ID

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Path parameters

idstringRequired

Responses

200

User updated successfully

application/json

400

Bad request - Invalid input data or user has been verified

application/json

401

Unauthorized - Invalid or missing API key

404

Not found - User does not exist

500

Internal server error

put

/user/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/user/{id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "createdAt": "2025-12-12T09:19:18.580Z",
  "updatedAt": null,
  "deletedAt": null,
  "fullNames": "text",
  "lastName": "text",
  "dateOfBirth": "text",
  "documentType": "text",
  "documentNumber": "text",
  "documentCountry": "text",
  "documentExpiryDate": "text",
  "mobileNumber": "text",
  "isVerified": true,
  "tenantId": "text",
  "azaId": null
}

Delete user

delete

/api/v1/

/user/{id}

Delete user by ID

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Path parameters

idstringRequired

Responses

200

User deleted successfully

application/json

ResponsestringExample: User has been deleted

401

Unauthorized - Invalid or missing API key

404

Not found - User does not exist

500

Internal server error

delete

/user/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/user/{id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

User has been deleted