A System Administrator can assign the Fulfillment Operator role to a Tenant Administrator. Once assigned, the Tenant Administrator can create new tenants through the Vantage API and grant this role to other users in their tenant. To create a tenant using the Vantage API, a Fulfillment Operator must:Documentation Index
Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
Use this file to discover all available pages before exploring further.
- Authorize in the Vantage API. For details, see Authentication.
- Send a POST request with the
Authorization = Bearer <access token>header to{baseUrl}/api/publicapi/v1/invites/, with the following request body parameters:
| Parameter | Description |
|---|---|
Model | An object that contains the following parameters: useMySubscription, email, tenantName, validWithin, and tenantDescription. |
email | The newly created Tenant Administrator’s email. |
validWithin | Time from the moment of sending, during which an invite can be accepted. The format is days.hours:minutes:seconds. The default value is 14.00:00:00 (14 days). |
tenantName | The tenant’s name. Tenant names must be unique. Creating a tenant with a name that already exists triggers an error. |
useMySubscription | Indicates whether the current tenant’s subscription should be reused. If enabled, both the current and new tenants share the same page-usage counter. When the counter is exhausted by either tenant, both are prevented from using it. The default is False, meaning a new subscription file must be downloaded. |
tenantDescription | The tenant’s description. This can be any text describing the tenant, and is visible to the System Administrator. |
Sample request
Related topics
Tenant management
Overview of tenant administration in Vantage
Managing Vantage API clients
Provision API clients for the new tenant
Creating a client using the Vantage API
Programmatic API client creation