How do I create an investment account?

Prev Next

You can create an investment account entity to link an investor record to one or more portfolios storing investments.

Call the UpsertInvestmentAccounts API, for example:

curl -X POST 'https://<your-domain>.lusid.com/api/api/investmentaccounts/$batchUpsert'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "upsert-request-1": {
    "displayName": "John Doe",
    "description": "Investment account for John Doe",
    "accountType": "Personal",
    "identifiers": {
      "InvestmentAccount/Identifiers/External": {
        "key": "InvestmentAccount/Identifiers/External",
        "value": {
          "labelValue": "93218920"
        }
      },
      "InvestmentAccount/Identifiers/Internal": {
        "key": "InvestmentAccount/Identifiers/Internal",
        "value": {
          "labelValue": "Internal_LKUH897YY"
        }
      }
    },
    "properties": {
      "InvestmentAccount/Details/Manager": {
        "key": "InvestmentAccount/Details/Manager",
        "value": {
          "labelValue": "Fred Bloggs"
        }
      }
    },
    "accountHolders": [
      {
        "key": "JohnDoe",
        "identifiers": {
          "InvestorRecord/Identifiers/External": {
            "key": "InvestorRecord/Identifiers/External",
            "value": {
              "labelValue": "IR_12345678"
            }
          }
        }
      }
    ],
    "investmentPortfolios": []
  }
}'
JSON

Coming soon

Coming soon

This section supplements the API documentation and on-screen help text in the LUSID web app.

An investment account must have at least one user-defined property identifier in the identifiers collection. It can have more than one.

An investment account must have an accountType of either:

  • Personal, in which case accountHolders must identify a single investor record with an underlying investor type of Person.

  • Corporate, in which case accountHolders must identify a single investor record with an underlying investor type of LegalEntity.

  • JointPersonal, in which case accountHolders can identify multiple investor records providing they all have an underlying investor type of Person.

  • JointCorporate, in which case accountHolders can identify multiple investor records providing they all have an underlying investor type of LegalEntity.

  • JointMixed, in which case accountHolders should identify at least two investor records, one with an underlying investor type of Person, and one with an underlying investor type of LegalEntity. There can be more investor records of either type.

An investment account should reference at least one portfolio in the investmentPortfolios collection. The key field enables you to provide a more friendly display name than may be possible amalgamating the portfolioScope and portfolioCode. It must be unique with the investment account.

You can optionally extend the data model of an investment account by adding custom properties from the InvestmentAccount domain. Soon you should be able to add or remove properties independently using dedicated APIs.

Once created, you can call the same UpsertInvestmentAccounts API again to change any attribute. To delete an investment account, call the DeleteInvestmentAccount API and specify one of its user-defined property identifiers.