Onboard a UAE company through Connect

Create the company

curl --request POST 'https://prod.gets.complyance.io/v3/connect/companies' \
  --header "X-API-Key: ${COMPLYANCE_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{
    "sourceName": "acme-dubai",
    "sourceVersion": "v1",
    "countryCode": "AE",
    "tin": "1234567890",
    "contactPersonEmail": "finance@example.com",
    "contactPersonName": "Alex Morgan",
    "branchName": "Dubai",
    "platformEnvironment": "sandbox"
  }'

Use a unique source name/version pair. Send the 10-digit TIN as a string. See the company reference for optional contact fields.

Save the returned identifiers

HTTP 201 means company creation succeeded. See the example response for the returned fields. Store data.companyId, sourceId, branchId, userGivenBranchId, peppolParticipantId, sourceName and sourceVersion against the customer in your application.

Use the returned source name/version for submission. Share userGivenBranchId with suppliers who need to address purchase invoices to this branch.

Check invoicing readiness

Read data.readyForInvoicing. Continue only when it is true. If mappingReadiness is returned with ACTION_REQUIRED, use its code to fix the mapping assignment.

A created company and a source ready for invoicing are separate results. Preserve the company instead of creating it again to fix a mapping.