Add User

The Add User API allows you to register an individual customer for transaction monitoring. This creates a new user profile that can then be tracked for transaction activity and compliance purposes.

API Endpoint

POST {base_url}/transactions/customers/AddUser

Request Format

This endpoint accepts a POST request with a JSON body.

Request Headers

Authorization: Bearer {token}
Content-Type: application/json

Request Body

{
  "entityType": "Individual",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "mobileNumber": "+966501234567",
  "tenantId": "your_tenant_id",
  "transactionMonitoring": {
    "userType": "TMIndividual",
    "country": "SA"
  }
}

Request Fields

Field	Type	Required	Description
entityType	string	Yes	Entity type — accepted value: Individual
firstName	string	Yes	Customer's first name
lastName	string	Yes	Customer's last name
email	string	No	Customer's email address
mobileNumber	string	No	Customer's mobile number
tenantId	string	Yes	Your tenant identifier
transactionMonitoring	object	Yes	Transaction monitoring configuration
transactionMonitoring.userType	string	Yes	User type — accepted value: TMIndividual
transactionMonitoring.country	string	Yes	2-letter ISO country code (e.g., SA, AE)

Response Format

{
  "version": null,
  "statusCode": 200,
  "messages": [
    "Processed successfully"
  ],
  "result": "70815d4e-0c3e-446c-a823-08e8db61a514"
}

Response Fields

Field	Type	Description
version	string	API version (nullable)
statusCode	number	HTTP status code
messages	string[]	Response messages
result	string	The unique identifier (UUID) of the newly created user

Example Usage

cURL Example

curl -X POST \
  '{base_url}/transactions/customers/AddUser' \
  -H 'Authorization: Bearer your_token_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "entityType": "Individual",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "mobileNumber": "+966501234567",
    "tenantId": "your_tenant_id",
    "transactionMonitoring": {
      "userType": "TMIndividual",
      "country": "SA"
    }
  }'

Error Handling

Status Code	Description	Solution
400	Invalid request — first name or last name is empty/whitespace	Ensure required fields are provided
401	Unauthorized	Verify your authentication token
403	Forbidden	Check that your account has the FillKyc permission
409	Tenant user limit exceeded	Contact support to increase your user limit
500	Internal server error	Contact support with the error details

Related Resources

• Add Company — Register a company for transaction monitoring
• Onboarding Pending — View pending onboarding customers
• Customer Details — Retrieve the full profile of a specific customer