Cache APIs support token-based authorization via the Authorization request header. The Authentication endpoint is used to retrieve an access token. After the access token is obtained, it must be inserted into the Authorization header for all requests.

Access tokens expire after 5 minutes, but can be refreshed within 30 minutes of issue.

Updates the information of an existing individual stakeholder identified by their unique individual number

An individual can be updated either via the API or by the Operations team through the Admin portal.

When the Operations team updates an individual in the admin portal, the system publishes the following webhook events:

1. individual.updated.success → triggered when individual update is successful See payload example:

   {
     "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
     "type": "individual.updated",
     "publishedAt": "2021-09-13T07:44:44.712943Z",
     "title": "Individual Updated",
     "body": {
      "individualNumber": "I1",
      "externalIndividualId": "1001",
      "stakeholderType" : INDIVIDUAL,
      "status" : ACTIVE,
      "source" : ADMIN_PORTAL
   }
   

Retrieves a paginated list of individuals matching the specified search criteria including name, status, and verification details with other details.

Creates a new individual stakeholder record in the system with the provided personal and identification details

An individual can be created either via the API or by the Operations team through the Admin portal.

When the Operations team creates an individual, the system publishes the following webhook events:

1. individual.created.success → triggered when individual creation is successful See payload example:

   {
     "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
     "type": "individual.created",
     "publishedAt": "2021-09-13T07:44:44.712943Z",
     "title": "Individual Created",
     "body": {
      "individualNumber": "I1",
      "externalIndividualId": "1001",
      "stakeholderType" : INDIVIDUAL,
      "status" : ACTIVE,
      "source" : ADMIN_PORTAL
    }
   

Updates the details of an existing company identified by its unique company number. Allows modification of company information such as contact details, address, and other relevant data.

A company can be updated either via the API or by the Operations team through the Admin portal.

When the Operations team updates a company, the system publishes the following webhook events:

1. company.updated.success → triggered when company update is successful See payload example:

   {
    "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
    "type": "company.updated.success",
    "publishedAt": "2021-09-13T07:44:44.712943Z",
    "title": "Company Updated Successfully",
    "body": {
        "companyId": 51,
        "companyName": "Some Company",
        "companyNumber": "C51",
        "status": "UPDATED"
    }
   }
   

Executes an advanced search across the company database with comprehensive filtering capabilities. Supports filtering by multiple criteria including company name, verification status, registration details, and other attributes. Returns paginated results that can be sorted based on specified parameters.

Creates a new company record with fundamental details such as company name, registration number, and contact information. The company is initially created with a 'NOT_VERIFIED' status.

A company can be created either via the API or by the Operations team through the Admin portal.

When the Operations team creates a company, the system publishes the following webhook events:

1. company.created.success → triggered when company creation is successful See payload example:

   {
    "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
    "type": "company.created.success",
    "publishedAt": "2021-09-13T07:44:44.712943Z",
    "title": "Company Created Successfully",
    "body": {
        "companyId": 51,
        "companyName": "Some Company",
        "companyNumber": "C51",
        "status": "NOT_VERIFIED"
    }
   }
   

Returns a complete list of all stakeholders associated with a company identified by its company number. The response provides comprehensive information for each stakeholder, including their roles (e.g., director, shareholder), ownership percentages, verification status, and other relevant details.

Registers new stakeholders (directors, shareholders, or key personnel) for a company identified by its unique company number. Important: This operation is only permitted when the company's verification status is either 'NOT_VERIFIED' or 'VERIFICATION_FAILED'. To maintain data integrity, stakeholder additions are blocked once a company's status becomes 'VERIFIED'.

A company can be updated either via the API or by the Operations team through the Admin portal.

When the Operations team updates a company, the system publishes the following webhook events:

1. company.updated.success → triggered when company update is successful See payload example:

   {
    "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
    "type": "company.updated.success",
    "publishedAt": "2021-09-13T07:44:44.712943Z",
    "title": "Company Updated Successfully",
    "body": {
        "companyId": 51,
        "companyName": "Some Company",
        "companyNumber": "C51",
        "status": "UPDATED"
    }
   }
   

Permanently removes a stakeholder from a company using the company number and stakeholder ID. This operation is restricted to companies with 'NOT_VERIFIED' or 'VERIFICATION_FAILED' status. For data integrity purposes, stakeholder removal is not permitted once a company becomes 'VERIFIED'. Warning: This action is irreversible and the stakeholder's information cannot be recovered after deletion.

A company can be updated either via the API or by the Operations team through the Admin portal.

When the Operations team updates a company, the system publishes the following webhook events:

1. company.updated.success → triggered when company update is successful See payload example:

   {
    "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
    "type": "company.updated.success",
    "publishedAt": "2021-09-13T07:44:44.712943Z",
    "title": "Company Updated Successfully",
    "body": {
        "companyId": 51,
        "companyName": "Some Company",
        "companyNumber": "C51",
        "status": "UPDATED"
    }
   }
   

Updates details of an existing Trust identified by trust number. Allows modification of trust information such as name, type, and other mutable fields. Requires valid trust number for identification.

A trust can be updated either via the API or by the Operations team through the Admin portal.

When the Operations team updates a trust, the system publishes the following webhook events:

1. trust.updated.success → triggered when trust update is successful See payload example:

   {
     "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
     "type": "trust.updated",
     "publishedAt": "2021-09-13T07:44:44.712943Z",
     "title": "Trust Updated",
     "body": {
      "trustNumber": "T1",
      "externalCompanyId": "1001",
      "stakeholderType" : TRUST
      "status" : ACTIVE,
      "source" : ADMIN_PORTAL
    }
   }
   

Search and retrieve paginated list of trusts based on specified criteria. Supports filtering by trust name, type, status, creation date, and other attributes. Results are paginated for efficient data retrieval.

Creates a new Trust record in the system with the provided trust details including name, type, and other relevant information. Returns comprehensive trust information including generated trust number.

A trust can be created either via the API or by the Operations team through the Admin portal.

When the Operations team creates a trust, the system publishes the following webhook events:

1. trust.created.success → triggered when trust creation is successful See payload example:

   {
     "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
     "type": "trust.created",
     "publishedAt": "2021-09-13T07:44:44.712943Z",
     "title": "Trust Created",
     "body": {
      "trustNumber": "T1",
      "externalTrustId": "1001",
      "stakeholderType" : TRUST,
      "status" : ACTIVE,
      "source" : ADMIN_PORTAL
    }
   }
   

Retrieves a complete list of stakeholders associated with the specified trust. The response includes detailed information about each stakeholder including their role, ownership percentage, and verification status.

Register new stakeholders for a specific trust using its trust number. Allows multiple stakeholders to be added in a single request. Each stakeholder record includes their role, ownership percentage, and personal details.

A trust can be updated either via the API or by the Operations team through the Admin portal.

When the Operations team updates a trust, the system publishes the following webhook events:

1. trust.updated.success → triggered when trust update is successful See payload example:

   {
     "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
     "type": "trust.updated",
     "publishedAt": "2021-09-13T07:44:44.712943Z",
     "title": "Trust Updated",
     "body": {
      "trustNumber": "T1",
      "externalCompanyId": "1001",
      "stakeholderType" : TRUST
      "status" : ACTIVE,
      "source" : ADMIN_PORTAL
    }
   }
   

Removes association between a stakeholder and a Trust. Requires trust number and stakeholder ID. Operation will be rejected if the Trust has been verified to maintain data integrity.

A trust can be updated either via the API or by the Operations team through the Admin portal.

When the Operations team updates a trust, the system publishes the following webhook events:

1. trust.updated.success → triggered when trust update is successful See payload example:

   {
     "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
     "type": "trust.updated",
     "publishedAt": "2021-09-13T07:44:44.712943Z",
     "title": "Trust Updated",
     "body": {
      "trustNumber": "T1",
      "externalCompanyId": "1001",
      "stakeholderType" : TRUST
      "status" : ACTIVE,
      "source" : ADMIN_PORTAL
    }
   }
   

Initiates the verification process for a stakeholder based on their type (INDIVIDUAL, COMPANY or TRUST) and unique stakeholder number.

The verification process includes:

1. Creating a FundOps help centre ticket to manually verify Companies and Trusts
2. Conducting background checks and company ownership structure verification
3. Performing necessary KYC/AML compliance verifications
4. Updating the stakeholder's verification status based on the verification results

The process may take time to complete. The response includes the current verification status and any additional requirements.

When verification is successful, the system publishes one of the following webhook events based on stakeholder type:

1. kyc.trust.success → triggered when trust verification is successful See payload example:

   {
    "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
    "type": "kyc.trust.success",
    "publishedAt": "2021-09-13T07:44:44.712943Z",
    "title": "KYC Trust Success",
    "body": {
        "trustNumber": "T1",
        "externalTrustId": "1001",
        "stakeholderType" : "TRUST",
        "status" : "ACTIVE",
        "source" : "ADMIN_PORTAL"
    }
   }
   

2. kyc.company.success → triggered when company verification is successful See payload example:

   {
    "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
    "type": "kyc.company.success",
    "publishedAt": "2021-09-13T07:44:44.712943Z",
    "title": "KYC Company Success",
    "body": {
        "companyNumber": "C1",
        "externalCompanyId": "1001",
        "stakeholderType" : "COMPANY",
        "status" : "ACTIVE",
        "source" : "ADMIN_PORTAL"
    }
   }
   

3. kyc.individual.success → triggered when individual verification is successful See payload example:

   {
    "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
    "type": "kyc.individual.success",
    "publishedAt": "2021-09-13T07:44:44.712943Z",
    "title": "KYC Individual Success",
    "body": {
        "individualNumber": "I1",
        "externalIndividualId": "1001",
        "stakeholderType" : "INDIVIDUAL",
        "status" : "ACTIVE",
        "source" : "ADMIN_PORTAL"
    }
   }
   

   On verification failure, the system publishes one of the following webhook events:

   1. kyc.trust.failed
   2. kyc.company.failed
   3. kyc.individual.failed

Administrative endpoint for authorized users to manually override the verification status of a stakeholder (INDIVIDUAL, COMPANY or TRUST).

This endpoint:

1. Requires appropriate administrative authorization
2. Updates verification status to VERIFIED
3. Records verification date and timestamp
4. Stores associated comments and reasons for the manual override
5. Maintains an audit trail of the manual verification change including:
   • User who performed the override
   • Previous verification status
   • Timestamp of the change
   • Reason for manual override

Note:

• This operation bypasses standard verification checks
• Should only be used in exceptional circumstances
• No webhook events are triggered for manual overrides
• All changes are permanently logged for compliance purposes

Initiates the Know Your Customer (KYC) verification process for an individual stakeholder and returns their current verification status along with detailed results. The verification requires the following mandatory information to be previously registered: first name, last name, date of birth, and complete residential address. The process validates the individual's identity against official databases and performs Anti-Money Laundering (AML) checks. The response includes verification status, timestamp, and any additional verification requirements.

An individual can be verified either via the API or by the Operations team through the Admin portal.

When the Operations team verified an individual, the system publishes the following webhook events:

1. individual.verified.success → triggered when verification is successful See payload example:

   {
     "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
     "type": "kyc.individual.success",
     "publishedAt": "2021-09-13T07:44:44.712943Z",
     "title": "KYC Individual Success",
     "body": {
      "individualNumber": "I1",
      "externalIndividualId": "1001",
      "stakeholderType" : INDIVIDUAL,
      "status" : ACTIVE,
      "source" : KYC
    }
   }
   

Uploads a document for stakeholder verification purposes as part of KYC/AML process. The system will document will be processed and verified by the system. Maximum file size: 20MB. Supported formats: PDF, JPG, PNG. The System will create a Help Centre ticket for verification tracking.

Retrieves and generates a comprehensive ownership structure for a company through the Simple KYC API integration. The operation returns detailed information about shareholders, directors, and beneficial owners.

Since this process takes time to complete, the system generates and stores the ownership structure asynchronously. Once the process is finished, the system publishes webhook events to notify subscribers of the result:

1. kyc.simple-kyc.success → triggered when Simple KYC processing is successful. See payload example:

{
    "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
    "type": "kyc.simple-kyc.success",
    "publishedAt": "2021-09-13T07:44:44.712943Z",
    "title": "Simple KYC Success",
    "body": {
        "companyId": 51,
        "companyName": "Some Company",
        "companyNumber": "C51",
        "companyAcn": "647382914",
        "status": "GENERATED"
    }
}

2. kyc.simple-kyc.failed → triggered when Simple KYC processing fails. See payload example:

{
    "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
    "type": "kyc.simple-kyc.failed",
    "publishedAt": "2021-09-13T07:44:44.712943Z",
    "title": "Simple KYC Failed",
    "body": {
        "companyId": 51,
        "companyName": "Some Company",
        "companyNumber": "C51",
        "companyAcn": "647382914",
        "status": "GENERATED_FAIL"
    }
}

Notes:

• Each API call to Simple KYC incurs charges according to their pricing structure.

Performs a search in the Simple KYC database using various identifiers: company name, ABN (Australian Business Number), or ACN (Australian Company Number). The search functionality is case-insensitive and supports partial matching for company names, enabling flexible and comprehensive search results.

Manually updates the verification status of an account. This endpoint should be used with caution and only in specific circumstances where automated verification processes need to be overridden. Requires appropriate authorization and will be audited for compliance purposes.

Updates the Distribution Reinvestment Plan (DRP) status for a specific investment option within an account. The DRP allows automatic reinvestment of distributions back into the same investment option instead of receiving cash payments. This setting can be configured independently for each investment option associated with the account.

Retrieves detailed information about a specific non-individual account using its unique identifier. The response includes complete account details including stakeholders, verification status, and other relevant information.

This endpoint updates the details of an existing Account.

Important rules and restrictions:

• This endpoint cannot be used to update the details of Account Stakeholders.
• If an Account has already been verified, the identity of the Stakeholders cannot be changed.
• The following fields are never updatable:
  • Account Type
  • Date/Time of Register
  • Identity of the Stakeholders

If any of the above details are incorrect, a new Account must be created instead of updating the existing one.

An account can be updated either via the API or by the Operations team through the Admin portal.

When the Operations team updates an account, the system publishes the following webhook events:

1. account.updated.success → triggered when account creation is successful See payload example:

   {
     "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
     "type": "account.updated",
     "publishedAt": "2021-09-13T07:44:44.712943Z",
     "title": "Account Updated",
     "body": {
      "accountId": "1",
      "externalAccountId": "1001",
      "status" : ACTIVE,
      "source" : ADMIN_PORTAL
    }
   }
   

This endpoint initiates the verification process for an account and all its stakeholders:

Verification Process:

• Triggers Know Your Customer (KYC) verification for all individual stakeholders associated with the account

Verification Outcomes:

• VERIFIED - All stakeholders successfully pass verification checks
• VERIFICATION_FAILED - One or more stakeholders fail verification

The account's verification status is updated based on the collective result of all stakeholder verifications.

An account can be verified either via the API or by the Operations team through the Admin portal.

When the Operations team verifies an account, the system publishes the following webhook events:

1. account.verified.success → triggered when account is verified. See payload example:

   {
     "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
     "type": "kyc.account.success",
     "publishedAt": "2021-09-13T07:44:44.712943Z",
     "title": "Account Verified",
     "body": {
      "accountId": "1",
      "externalAccountId": "1001",
      "status" : ACTIVE,
      "source" : ADMIN_PORTAL
    }
   }
   

2. account.verified.failed → triggered when account is verification failed. See payload example:

{
   "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
   "type": "kyc.account.failed",
   "publishedAt": "2021-09-13T07:44:44.712943Z",
   "title": "Account Verification Failed",
   "body": {
       "accountId": "1",
       "externalAccountId": "1001",
       "status" : ACTIVE,
       "source" : ADMIN_PORTAL
     }
}

Uploads a new document for the specified account. Supported documents include bank account verification, identification documents, proof of address, and other account-related documentation. Documents must be in PDF, JPG, or PNG format with a maximum size of 20MB.

Creates a new non-individual account with the provided details. This endpoint allows you to set up various account types including Company, Trust, and other non-individual entities. The account types JOINT_HOLDING, INDIVIDUAL, COMPANY, TRUST, and MINOR will be automatically marked as VERIFIED if their account stakeholders are already VERIFIED

The following rules apply to Registered Holders and Beneficial Holders based on the Account Type:

Individual

• Exactly 1 Registered Holder, which must be Stakeholder Type = Individual.
• No Beneficial Holder.

Minor

• Exactly 1 Registered Holder, which must be Stakeholder Type = Individual.
• Exactly 1 Beneficial Holder, which must be Stakeholder Type = Individual.

Company

• Exactly 1 Registered Holder, which must be Stakeholder Type = Company.
• No Beneficial Holder.

Joint

• Exactly 2 Registered Holders, which must be Stakeholder Type = Individual.
• No Beneficial Holder.

SMSF

• At least 1 (possibly more) Registered Holder, which may be Stakeholder Type = Company or Individual (Trustees).
• Exactly 1 Beneficial Holder, which must be Stakeholder Type = Trust.

Trust

• At least 1 (possibly more) Registered Holder, which may be Stakeholder Type = Company or Individual (Trustees).
• Exactly 1 Beneficial Holder, which must be Stakeholder Type = Trust.

An account can be created either via the API or by the Operations team through the Admin portal.

When the Operations team creates an account, the system publishes the following webhook events:

1. account.created.success → triggered when account creation is successful See payload example:

   {
     "webhookId": "5ba28486-1ece-4786-bbed-21fca2235edf",
     "type": "account.created",
     "publishedAt": "2021-09-13T07:44:44.712943Z",
     "title": "Account Created",
     "body": {
      "accountId": "1",
      "externalAccountId": "1001",
      "status" : ACTIVE,
      "source" : ADMIN_PORTAL
    }
   }
   

A rollover is an investment procedure where:
- An Investor redeems units from one Fund held in one Account.
- The proceeds of this redemption are used by the Investor for an application for units in either the same Fund or a different one. This application is done within another Account, which can either be a new one or an existing one.
- A significant condition to be met is that the first and second Accounts need to have the same Interested Parties.

Bank details are optional. Cloned account shall use the bank details from the request. If no bank details are provided in the request, the System shall use the bank account details from the source account. In case, source account doesn't have any bank details and no bank details are provide in the request the account shall not have any bank details

Returns a list of distribution details for a specific account within a given date range.

The response includes distribution details like payment amount, reinvestment amounts and units, and other details.

Both fromDate and toDate parameters are required and must be in yyyy-MM-dd format.

The date range is inclusive of both start and end dates.

Following webhook is published to notify clients that the distributions are completed for a specific period :

1. distribution.completed → notifies when distribution is completed. See payload example:

   {
    "fromDate": "2025-01-01",
    "toDate": "2025-01-31"
   }
   

Search for non-individual accounts using various criteria. The search can be filtered by account status, type, creation date, and other parameters defined in the NonIndividualAccountPredicate. Results are paginated for better performance and data management.

Retrieves the Distribution Reinvestment Plan (DRP) status for a specific account. The response includes information about whether distributions are currently being reinvested and the reinvestment preferences for different investment options.

Retrieves all tags that have been assigned to a specific investor. Tags can be used to categorize and filter investors for reporting and management purposes. Returns an empty set if no tags are associated with the investor.

This endpoint allows you to add one or more tags to an investor's account. Tags are useful for categorizing and filtering investors. If a tag already exists for the investor, it will not be duplicated.