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.

Update the interest rate with a specified date for an investment option.

Returns a list of investment options available within the Fund.

Retrieves the most recent recorded unit price for an investment option.

Returns an array of all the unit prices determined for an investment option within a date period.

The response will not provide a unit price for days on which a unit price was not determined (e.g. on a weekend or public holiday).

The 'fromDate' must be less than the 'toDate' and the 'toDate' must be less than or equal to today's date.

Retrieves the most recent recorded interest rate for an investment option.

Returns an array of all the interest rates determined for an investment option within a date period.

The response will not provide a unit price for days on which a unit price was not determined (e.g. on a weekend or public holiday).

The 'fromDate' must be less than the 'toDate' and the 'toDate' must be less than or equal to today's date.

Returns current holding balance of the investment option

Provides total balance of investment option. It supports only logicType. Holding Balance has following Balance Logic Types.

Returns a paginated collection of accessible Investors.

The API may be configured to limit the resulting Investor Collection to ensure that only minimal relevant data is exposed and only when required.

Retrieves the details of an existing investor.

Updates the details of an existing investor. Any attributes not provided will be left unchanged.

Once an investor has passed ID verification, some attributes may not be changed. If you would like to change these details, we can process this manually after the new identity has also passed verification.

If you provide the same details that we already have (ie there are no changes), the API will return a HTTP 200 status.

Updates the details of an existing investor. If the field tfn is not provided, it will be left unchanged.

Once an investor has passed ID verification, first_name, last_name, middle_name and date_of_birth can't be changed. If you would like to change these details, we can process this manually after the new identity has also passed verification.

Investors can update TFN anytime (even after KYC is completed and transactions made). When TFN is changed (if it was previously not null), an alert is sent to Cache for fraud monitoring purposes.

If you provide the same details that we already have (ie there are no changes), the API will return a HTTP 200 status.

This API endpoint provides the functionality to update an investor's account for registry in case previous try was unsuccessful

The API will return a HTTP 200 status.

This API endpoint provides the functionality to create an investor's account for registry in case previous try was unsuccessful

In case of another fail registry_account_id will remain null

The API will return a HTTP 200 status.

Returns distribution collections of an Investor.

You can verify an Investor by triggering this API. If an Investor is not verified by the time we receive their first investment instruction, we will process a verification at that time before accepting the instruction.

Triggers the ID verification of an existing investor.

Our flows automatically trigger ID verification on new customers. We can configure our platform so ID verification occurs upon Create Investor, when we have received the investor’s first investment instruction or when we have received the cash to pay for the investor’s first investment instruction (however successful ID verification must occur before we may accept an investment instruction for that investor).

This endpoint is intended to be used to re-verify an investor after their details have been updated.

The API will return a result confirming whether ID verification was passed and further details.

This endpoint assists onboard investors that are foreign tax residents.

We can only accept investors that are tax residents of Australia, or another country that appears on our List of Acceptable Countries.

Use this endpoint to retrieve the Name and Country ID of all countries that appear on our List of Acceptable Countries.

When an investor confirms that they are a tax resident of a foreign company, record the appropriate Country ID on their Investor record.

Retrieves the banking details for an existing investor.

This API allows investors to update their bank details if their current holding is $0. If their holding is >$0 then you will need to contact the Cache support via email (with a bank statement of the new account) to update their bank details.

We only support standard Australian bank account & BSB. Australian banking standards mandate a 6 digit BSB and 6-9 digit account numbers. Only digits allowed. Furthermore, certain account numbers (ex, 999999 or 802919) are reserved and cannot be used.

For security reasons, we don’t allow special characters to be used in any of the input parameters. See below the regular expression we use for validation.

ACCEPTED_CHARACTERS_REGEX = \"^[a-zA-ZàáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ð ',.'-]{0,48}+$\";

Creates a ‘linked bank account’ for an existing investor.

All direct debit requests and withdrawal payments may only be made to a linked bank account stored for the relevant investor.

At this time, each investor may only create one linked bank account.

We only support standard Australian bank account & BSB. Australian banking standards mandate a 6 digit BSB and 6-9 digit account numbers. Only digits allowed. Furthermore, certain account numbers (ex, 999999 or 802919) are reserved and cannot be used.

For security reasons, we don’t allow special characters to be used in any of the input parameters. See below the regular expression we use for validation.

ACCEPTED_CHARACTERS_REGEX = \"^[a-zA-ZàáâäãåąčćęèéêëėįìíîïłńòóôöõøùúûüųūÿýżźñçčšžÀÁÂÄÃÅĄĆČĖĘÈÉÊËÌÍÎÏĮŁŃÒÓÔÖÕØÙÚÛÜŲŪŸÝŻŹÑßÇŒÆČŠŽ∂ð ',.'-]{0,48}+$\";

This endpoint retrieves the list of Investor Tags for an Investor.

This endpoint creates an Investor Tag for an Investor.

Provides a snapshot of the investments currently held by an existing investor.

Provides historical balance of the investments currently held by an existing investor.

Provides a snapshot of the tagged investments currently held by an existing investor.

Provides a balance of the investments held by an existing investor. Holding Balance has following Balance Logic Types.

This endpoint calculate subscription fees based on the given setting and given holdings.

This endpoint retrieves the current Subscription Status for an Investor. +That is, an Investor is either a "Subscriber" that is currently in a "Subscription Fee Period" or they are not.

This endpoint retrieves information relating to the Subscription Fee Period that the Investor is currently in (including dates and estimated fee amount).The API shall throw exception "No holding available for this period" if the investor doesn't have any cleared holdings.

Returns a list of all transaction instructions for an existing investor.

You may request a filtered list by ‘date’, ‘instruction type’ or ‘transaction type’ to reduce the volume of data returned.

Retrieves the details of an instruction, including a list of the transactions that have been created by it.

Use this endpoint to cancel a recurring application Instruction for an Investor.

Creates a new ‘application’ transaction instruction, being a request by the investor to invest in the Fund.

Application transaction instructions may apply to more than 1 investment option and may be set to recur weekly, fortnightly or monthly. Recurring transactions may be set to recur a specified number of iterations, until a particular date has passed or until cancelled.

In case of direct debit as funding source sum of all applications is capped by direct debit limit of client (50000 by default). If application sum is exceeding this limit error will be occurred, to find out the limit check with Cache. Manual funding source is uncapped

Use this endpoint to retrieve all the recurring application instructions for an Investor.

Use this endpoint to retrieve the details of a 'real time redemption' instruction (including payment status and remaining payout amount).

Use this endpoint to update the payment status of a 'real time redemption' instruction (including the payment status of the "immediate payout" and the "remaining payout").

This endpoint is designed to be used by clients of Cache that operate their own redemption liquidity account.

Use this endpoint to creates a new 'redemption' instruction, which is a request by the Investor to withdraw money from the Fund. " + "Each redemption instruction applies to one investment option only." + " "Full Redemptions" (a redemption for all the "cleared" units held by an Investor): If Full Redemption is True, then both Units and Amount must be zero." + " "Partial Redemptions" (a redemption for less than all remaining units held by an Investor): If Full Redemption is False, then either Units or Amount must be provided and the other must be zero." + " Redemptions created using this endpoint do not follow our "real time liquidity" payment flow. Note: We do not accept redemption instructions for uncleared or pending balances. " + "Investors should be advised to wait until all pending applications are cleared (ie they are no longer pending) before seeking to make a Full Redemption. " + "If an investor submits a Full Redemption while they have a "pending" application and the "pending" instruction is successful, the investor will ultimately retain a residual balance.

Creates a new ‘realtime redemption’ transaction instruction, being a request by the investor to withdraw money from the Fund.

Each redemption transaction instruction applies to 1 investment option.

Creates a new ‘switch’ transaction instruction, being a request by the investor to move money from one investment option to another.

Retrieves the tag list of an instruction by Instruction ID

Use this endpoint to import a new 'redemption' instruction, being a request by the Investor to withdraw money from the Fund. Each redemption instruction applies to 1 investment option only.

Imports a new ‘application’ transaction instruction, being a request by the investor to invest in the Fund.

Application transaction instructions may apply to more than 1 investment option.

Returns a list transactions retrieved by their IDs. The results will not include cancelled or rejected transaction instructions.

You may request a filtered list by ‘application’, ‘redemption’ or ‘switch’.

Returns a list of all transactions for an existing investor. This is a historic record of the actual transactions that have been processed on behalf of an investor, and will not include cancelled or rejected transaction instructions.

You may request a filtered list by ‘application’, ‘redemption’ or ‘switch’.

Retrieves the details of a particular transaction.

Returns a list of all transactions with the transaction tags.

Use this API to retrieve the transaction fees that will apply to a transaction instruction.

For an application investment instruction (which may relate to multiple investment options), you can provide an array of investment options with investment amounts.

For a redemption (which only apply to a single investment option), you may provide an array of 1 investment option.

For a switch, you may provide an array of 1 investment option which relates to the option you are switching into (do not include the details of the investment option you are switching out of).

You can also provide amounts ‘inclusive’ of the transaction fee (ie the ‘gross amount’) or ‘exclusive’ of the transaction fee (ie the ‘net amount’) by selecting the appropriate ‘fee type’. Please note: this only applies to Application transaction types.

Redemption and switch transactions are always fee inclusive (fee_type parameter will be ignored for these operations).

This fully funded and unitisation can be done only at Sandbox.

Create a daily unit price for each investment option can be done only at Sandbox environment.

Update the paid amount of invoice for invoice by its reference code.

Retrieves client's invoice details by its reference code.

Retrieves summarized total of client's invoice by its reference code.

Download a pdf file of tax statement by each investor.

Retrieves available tax statement list

Use this endpoint to create a Minor Account (being an Account held by a parent on behalf of their child).

For legal purposes, the Account will be held in the following name "[Parent Full Name] as guardian for [Minor Full Name]".

The Account Name, email and address will be used for the purpose of tax statements and other legal documents.

Each Minor Account must include exactly 2 Interested Parties, being:
- the Registered Holder (being the Parent); and
- the Beneficial Holder (being the Minor).

The Registered Holder must:
- Be the parent or guardian of the Beneficial Holder
- Be an individual (and will be recorded as Type = Individual)
- Have a First Name, Middle Name, Last Name, Date of Birth, Phone Number and Email Address

The Beneficial Holder must:
- Be the child of the Registered Holder
- Be an individual (and will be recorded as Type = Minor)
- Have a First Name, Middle Name, Last Name and Date of Birth

Use this endpoint to retrieve the details of an existing Account.

This endpoint will retrieve the Registered Holder and Beneficial Holder for the Account.

If you would like to retrieve the details of their shareholders, directors or other stakeholders you will need to make another call for them directly.

Force Update verification status of an Account

Update Distribution Reinvestment Status of Account

This endpoint is used to update the details of an Account.

This endpoint is not used to update the details of a Holder.

When an Account has been verified, you may not change the identity of the Stakeholders.

You may never update:

• Account Type;
• DateTime of Register
• The identity of the Stakeholders.

If these details are incorrect, you will need to create a new Account.

This endpoint is used to trigger a manual KYB verification of an account.

It generates a ticket in our Fund Ops team to process the KYB.

KYB verifications are asynchronous and can take time.

You will be updated on the results of the KYB by webhook and/or a Help Desk ticket.