How do I create an investment account?

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

Methods

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": {
    "scope": "my-investment-account-scope",
    "displayName": "John Doe",
    "description": "Investment account for John Doe",
    "accountType": "Individual",
    "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",
        "scope": "my-investor-record-scope",
        "identifiers": {
          "InvestorRecord/Identifiers/External": "IR_12345678"
        }
      }
    ],
    "investmentPortfolios": [
      {
        "key": "cash",
        "scope": "my-portfolio-scope",
        "identifiers": {
          "Portfolio/default/Code": "my-cash-portfolio-code"
        }
      },
      {
        "key": "dividends",
        "scope": "my-portfolio-scope",
        "identifiers": {
          "Portfolio/default/Code": "my-dividend-portfolio-code"
        }
      }
    ]
  }
}'

Data fields and properties

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

Fields

An investment account has a scope. It must also have at least one user-defined property identifier in the identifiers collection (it can have more than one). Note two investment accounts in the same scope with the same property identifier must have different values for that identifier.

An investment account must have an accountType of either:

• Individual, 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.

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

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

An investment account should reference at least one portfolio in the investmentPortfolios collection. The key field enables you to provide a friendly name, and must be unique with the investment account.

Properties

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.

Subsequent updates

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.