Connect API v3 — UAE company onboarding

Use the Connect API to create a UAE company and its onboarding record in the workspace associated with your API key.

Endpoint

POST https://prod.gets.complyance.io/v3/connect/companies

Authentication

Include your Complyance API key in the X-API-Key header.

X-API-Key: <YOUR_API_KEY>
Content-Type: application/json

The API key determines the workspace in which the company is created. Do not include a workspace ID in the request.

Request body

Field	Type	Required	Description
`sourceName`	string	Yes	Name of the source system, such as `quickbooks`.
`sourceVersion`	string	No	Version of the source integration.
`legalName`	string	Yes	Legal name of the company.
`countryCode`	string	Yes	ISO country code. Use `AE` for a UAE company.
`tin`	string	Yes for UAE	The company's 10-digit UAE tax identification number.
`contactPersonEmail`	string	Yes for UAE	Email address of the onboarding contact.
`branchName`	string	No	Human-readable branch name.
`branchId`	string	No	Identifier used by the source system for the branch.
`platformEnvironment`	string	No	Target platform environment. Use `sandbox` for non-production onboarding.

Example request

curl --request POST 'https://prod.gets.complyance.io/v3/connect/companies' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "sourceName": "quickbooks",
    "sourceVersion": "v1.000",
    "legalName": "Example UAE Entity",
    "countryCode": "AE",
    "tin": "1234567890",
    "contactPersonEmail": "onboarding@example.com",
    "branchName": "Main",
    "branchId": "main",
    "platformEnvironment": "sandbox"
  }'

UAE validation requirements

sourceName, legalName, and countryCode are required.
When countryCode is AE, tin and contactPersonEmail are also required.
tin must contain exactly 10 digits.
sourceVersion, branchName, branchId, and platformEnvironment are optional.

Successful onboarding

A successful request returns 201 Created. The company and its UAE onboarding record are created in the workspace associated with the supplied API key.