Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
b) Tenant Configuration & Onboarding

List tenants

Returns all tenants registered on the platform. Only available to administrators. Results can be filtered by name or institution.

get/eclipse-conductor/rest/v1/tenants

Query parameters

fieldsstring

Pass meta-data to get additional tenant fields like pool account and wallet identifier data

institutionstring
limitinteger
namestring
offsetinteger
onlyShowAllowedboolean

If true, returns only tenants the authenticated user has permission to access. If false and the user lacks permission, an error is returned.

Response

OK

base64ExportedTenantConfigurationstring

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

businessType'CLOSE_CORPORATION' | 'LIMITED_COMPANY' | 'PARTNERSHIP' | 'PERSONAL_LIABILITY_COMPANY' | 'PUBLIC_LISTED_COMPANY' | 'SOLE_PROPRIETOR' | 'STATE_OWNED_COMPANY' | 'TRUST' | 'UNREGISTERED'
categoryCodeinteger

Four digit Category code for this tenant.

companyNumberstring

Legal company number of the tenant

createdstring date-time

ISO 8601 date/time of when the record was first created

emailstring

Primary email address of the tenant

industrialClassificationstring
industrialSectorstring
institutionstring

Optional. The accountable institution that the tenant falls under

lastModifiedstring date-time

ISO 8601 date/time of when the record was last modified

merchantIdstring

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

namestring

Name of the tenant - typically company name

phone1string required

Tenants primary phone number

primaryPoolAccountNumberstring
status'ACTIVE' | 'BARRED' | 'INACTIVE'

Status of the eclipse organisation. ACTIVE:Organisation is active, INACTIVE:Organisation is in active, BARRED:Organisation is in barred

taxNumberstring

Tax number of the tenant

tenantIdinteger

Unique identifier for a tenant. System generated upon creation of a new tenant. Should be passed as a path parameter for many of the API's which are specific to the tenant

tradingNamestring
vatNumberstring

VAT number of Tenant

versioninteger required

A number indicating the version of the record. Updates will only be accepted if the passed in version is the same as the current version on record. This is in order to prevent concurrent modifications by multiple users.

walletIdentifiersstring[]

Example response

[
  {
    "created": "2022-03-10T12:15:50-04:00",
    "lastModified": "2022-03-10T12:15:50-04:00"
  }
]