Create Tenant

Create Tenant #

Restricted Feature
This feature is only available for specifically authorized service providers. Please contact us if you require this functionality.

Creating a new Tenant #

The Create Tenant API creates a new Authorized Trading Partner Enterprise Account in CARO with the provided information in the request body of the endpoint call.

Request #

Method #

Request methodEndpoint
POST/api/v1/serviceProviders/tenants

Headers #

Authentication
Please see Obtaining and using a Token for a detailed description of how to authenticate yourself with our API.

Note that bearer tokens have a validity of 24 h. Please reuse each token until its expiry.

NameValue
Content-Typeapplication/json
AuthorizationBearer: [token]

Body #

Example request body
{
    "name": "Some Pharma Company",
    "initialUser": "manager@pharma.com",
}
KeyDescriptionTypeRequired
nameName of the enterprisestring
initialUserEmail address of the initial user who will manage this Enterprise Accountstring
Choosing name
The name should be the legal name of the trading partner company you serve as a VRS provider.
Choosing initialUser
The initial user must be someone in a managerial role within the trading partner company.

Response #

Successful Response #

{
    "data": {
        "id": "79806b8f-f4d4-474b-a069-657c3eb8aae9",
        "createdAt": "2022-06-01T10:05:51.004Z",
        "updatedAt": "2022-06-01T10:05:51.004Z",
        "slug": "some-pharma-t-162b",
        "name": "Some Pharma Company",
        "webUrl": "",
        "demo": "NONE"
    },
    "_meta": {}
}

Examples #

Curl #

curl --location --request POST 'https://app.caro.vc/api/v1/admin/tenants' \
--header 'Authorization: Bearer [YOUR_API_TOKEN]' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Some Pharma Company",
    "initialUser": "manager@pharma.com"
}'