Integration Guides

Organisation Use Cases

Suggest Edits

Create an Organisation

To create an Organisation

Prerequisites

  • KYB documentation available.
  • Search organisation to look for potential duplicates within the Tenant.
  • Need organisations information (Name, Trading Name, Tax Number Registration Number, Address etc)
  • Valid JWT**

Step 1 – Create Organization
Create the Organisation

This refers to the following API in swagger:

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations

Step 2 – Add Address Details
Add address details for the organisation now that you have an Organisation ID

This refers to the following API in swagger:

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/addresses

Step 3 – Add Supporting Documentation
Add Organisation supporting documentation.

This refers to the following API in swagger:

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/documents

Step 4 – Kick off Ratify

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/ratify

This will kick off the various checks and algorithms in Eclipse to analyse the organisation profile, address/s and attached documents to update the organisations KYB status. This call will return detailed results of the KYB process such as what passed and what failed in the various tests. The organisation profile can be updated along with addresses and documents and ratified again until the required KYB status for the wallet type is obtained. The wallet type determines what level of KYB is required for a customer/organisation to own that type of wallet.

Step 5 – Create Wallet
Create a wallet which will be used to top up customer wallets

This refers to the following API in swagger:

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/wallets

Add Positions to Organisation

To link a customer as having a position in an organisation

Prerequisites

  • Create the Customer and have the customerId
  • Organisation ID
  • Valid JWT

Step 1 – Create Customer Position within the Organisation
Post the position of the customer

This refers to the following API in swagger:

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/positions

Register a new customer as part of an organisation and issue a virtual card linked to an Organisation wallet

In order to sign up a new customer and issue a virtual card, first create the customer along with the required customer information and then create the wallet under an organisation passing the customerId.
(With the creation of the Wallet, the card is automatically created )

Follow steps 1 - 5 of Register a new customer and issue a virtual card

Step 1 – Create Wallet under Organisation
Create a wallet which will automatically be created and link the virtual card.

This refers to the following API in swagger:

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/wallets

Do not populate the primaryPhysicalCardIdentifier fields.
Set the customerId to the customer who will be the first cardholder on the wallet.

Organisation KYC Validation and Update

If required, you can validate and update an organisation's KYB documents and KYB status.

Prerequisites

  • Organisation Documents to be created and uploaded.
  • organisationId
  • Valid JWT

Step 1 – Update profile, addresses, documents
PUT/DELETE the organisation's profile, documents and addresses with the necessary changes

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/addresses

Step 2 – Validate Organisation using Ratify
Run a KYB algorithm on the organisation profile and update the KYB status

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/ratify

This will return a detailed status of the checks passed/failed

Create an Organisation Wallet

To create an Organisation Wallet.

Prerequisites

  • Pre-existing organisationId
  • Valid JWT

Step 1 – Create an Organisation Wallet

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/wallets

An Organisation digital wallet can be associated just to an Organisation while an Organisation card wallet always needs to be associated to a customer as well. In some scenarios you might want an Organisation digital wallet to also be linked to a customer. In this scenario set the customerId to the customer you want this wallet to be linked to. This customer would need to have a position in the organisation.

Request an Organisation Wallet Balance

An organisation may request a wallet balance, subject to the program access rules. Note that a organisation may have multiple wallets

Prerequisites

  • Pre-existing organisation wallet creation and balance details:
  • tenantId
  • walletId
  • Valid JWT

Step 1 – Request Organisation Wallet Balance
Perform a single wallet balance request. 

GET /eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}

You can also get multiple wallet balances using 

GET /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/wallets

Get Wallet Transaction History (Statement)

Same as for a customer’s wallet
Update Organisation information
To update an organisation information

Prerequisites

  • Pre-existing organisation information:
  • tenantId
  • organisationId
  • Valid JWT

Step 1 – Update Organization Information

PUT /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}

Update Organisation Address

Prerequisites

  • Pre-existing organisation address:
  • tenantId
  • AddressID GET/eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisationId}/addresses)
  • Valid JWT

Step 1 – Update organization address

PUT /eclipse-conductor/rest/v1/tenants/{tenantId}/addresses/{addressId}

Update Organisation Documentation

Prerequisites

  • Pre-existing organisation documentation
  • tenantId
  • documentId
  • Valid JWT

Step 1 – Update organization documentation

PUT /eclipse-conductor/rest/v1/tenants/{tenantId}/documents/{documentId}

Updated almost 2 years ago