Connect API
Manage companies and branches in your ISV workspace and retrieve document counts.
Authentication
Base URL: https://prod.gets.complyance.io. Send your ISV workspace key in X-API-Key. See authentication.
Operations
| Method and path | Purpose |
|---|---|
POST /v3/connect/companies | Onboard a UAE company |
GET /v3/connect/companies | List company sources |
GET /v3/connect/companies/{sourceName} | Retrieve a company source |
PATCH /v3/connect/companies/{sourceName} | Update a company source |
DELETE /v3/connect/companies/{sourceName} | Archive a company source |
POST /v3/connect/companies/{companyId}/branches | Add a branch |
POST /v3/connect/companies/{companyId}/branches/bulk | Add up to 100 branches |
POST /v3/connect/companies/onboarding-jobs | Onboard up to 500 rows |
GET /v3/connect/invoices/counts | Read document counts |
Identifiers
| Value | Where to use it |
|---|---|
companyId | Branch creation and company-level count filters |
sourceName and sourceVersion | Identify your source; use sourceName:sourceVersion when submitting an invoice |
sourceId | Identify a returned source where an operation explicitly accepts it |
branchId | Identify a returned branch where an operation explicitly accepts it |
userGivenBranchId | Share with suppliers as the buyer branch reference, cbc:BuyerReference |
Treat returned identifiers as opaque. Do not interchange them.
Errors
See Connect errors. After a timeout during company creation, list existing companies before trying to create the company again.
Last updated