Add Company

The Add Company API allows you to register a corporate entity for transaction monitoring. This creates a new company profile that can then be tracked for transaction activity and compliance purposes.

API Endpoint

POST {base_url}/transactions/customers/AddCompany

Request Format

This endpoint accepts a POST request with a JSON body.

Request Headers

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

Request Body

{
  "entityType": "Organization",
  "fullName": "Acme Corporation",
  "tradingName": "Acme Corp",
  "email": "compliance@acme.com",
  "phoneNumber": "+966501234567",
  "tenantId": "your_tenant_id",
  "transactionMonitoring": {
    "firstName": "Jane",
    "lastName": "Smith",
    "userType": "TMLegalEntity",
    "country": "SA"
  }
}

Request Fields

Field	Type	Required	Description
entityType	string	Yes	Entity type — accepted value: Organization
fullName	string	Yes	Company's registered full name
tradingName	string	No	Company's trading or brand name
email	string	No	Company's contact email
phoneNumber	string	No	Company's phone number
tenantId	string	Yes	Your tenant identifier
transactionMonitoring	object	Yes	Transaction monitoring configuration
transactionMonitoring.firstName	string	Yes	Contact person's first name
transactionMonitoring.lastName	string	Yes	Contact person's last name
transactionMonitoring.userType	string	Yes	User type — accepted value: TMLegalEntity
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 company

Example Usage

cURL Example

curl -X POST \
  '{base_url}/transactions/customers/AddCompany' \
  -H 'Authorization: Bearer your_token_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "entityType": "Organization",
    "fullName": "Acme Corporation",
    "tradingName": "Acme Corp",
    "email": "compliance@acme.com",
    "phoneNumber": "+966501234567",
    "tenantId": "your_tenant_id",
    "transactionMonitoring": {
      "firstName": "Jane",
      "lastName": "Smith",
      "userType": "TMLegalEntity",
      "country": "SA"
    }
  }'

Error Handling

Status Code	Description	Solution
400	Invalid request parameters	Ensure required fields are provided with valid values
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 User — Register an individual for transaction monitoring
• Onboarding Pending — View pending onboarding customers
• Customer Details — Retrieve the full profile of a specific customer