Register a new tenant on the Eclipse Platform

post

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants

A tenant is a client of the Eclipse platform. Only available to administrators

Body Params

allowInitialTenantSetup

boolean

If it is true then it will create admin users and tenant wallets based on either default config or config passed on tenantSetupTemplate.

businessType

string

enum

The type of the business. This will be supplementary to Tenant type when selected type of business.

categoryCode

int64

Four digit Category code for this tenant.

companyNumber

string

length between 5 and 20

Legal company number of the tenant

string

Primary email address of the tenant

exportedTenantConfigurations

string

Optional. It is tenant detail like wallet type, wallet, admin users exported Tenant Configuration as JSON

industrialClassification

string

length between 3 and 50

industrialSector

string

length between 3 and 50

institution

string

length between 3 and 3

Optional. The accountable institution that the tenant falls under

merchantId

string

Merchant Id used for some card payment types to the tenants wallet

name

string

length between 3 and 50

Name of the tenant - typically company name

phone1

string

required

Tenants primary phone number

taxNumber

string

length between 3 and 20

Tax number of the tenant

tenantSetupPermissionTemplate

string

tenantSetupTemplate

string

Initial tenant setup config template. Used when allowInitialTenantSetup is true. if no value passed then use default template

tradingName

string

length between 3 and 50

vatNumber

string

VAT number of Tenant

Responses

400

Bad Request

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK