Register a new organisation

post

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/organisations

An organisation is a grouping of customers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

Body Params

A company, organisation or grouping of customers which can in turn own a wallet, have an address or have associated documents. Typically known as a Juristic but organisation can also include just a grouping of people like a family.

bankDetails

array of objects

bankDetails

businessRegistrationDate

string

length between 8 and 8

Business registration date must be in form of yyyyMMdd

businessType

string

enum

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

categoryCode

int64

Four digit Category code for this organisation.

companyNumber

string

length between 5 and 20

Legal company number of the organisation

string

Email address of the organisation

externalUniqueId

string

required

length between 6 and 100

A globally unique identifier set by the tenant for this organisation. Useful for correlating between the tenants systems and Eclipse

industrialClassification

string

length between 3 and 50

industrialSector

string

length between 3 and 50

merchantId

string

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

name

string

length between 3 and 50

Name of the organisation

phone1

string

Organisations primary phone number

phone2

string

Organisations secondary phone number

taxNumber

string

length between 3 and 20

Tax number of the organisation

tradingName

string

length between 3 and 50

type

string

enum

The type of the organisation

Allowed:

vatNumber

string

VAT number of organisation

Responses

400

Bad Request

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

application/json

200OK