How do I create an investor record?

Prev Next

You can create an investor record entity to collate all the information pertaining to a particular investor in a particular jurisdiction.

Note the investor must already be mastered in LUSID as either a person or a legal entity.

Call the UpsertInvestorRecords API, for example:

curl -X POST 'https://<your-domain>.lusid.com/api/api/investorrecords/$batchUpsert'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "upsert-request-1": {
    "displayName": "John Doe",
    "description": "Investor record for John Doe",
    "identifiers": {
      "InvestorRecord/Identifiers/External": {
        "key": "InvestorRecord/Identifiers/External",
        "value": {
          "labelValue": "IR_12345678"
        }
      },
      "InvestorRecord/Identifiers/Internal": {
        "key": "InvestorRecord/Identifiers/Internal",
        "value": {
          "labelValue": "Internal_XHSP2038"
        }
      }
    },
    "properties": {
      "InvestorRecord/Details/Country": {
        "key": "InvestorRecord/Details/Country",
        "value": {
          "labelValue": "United States"
        }
      }
    },
    "investor": {
      "investorType": "Person",
      "investorIdentifiers": {
        "Person/Identifiers/HNWI": {
          "key": "Person/Identifiers/HNWI",
          "value": {
            "labelValue": "XY10001111"
          }
        }
      }
    }
  }
}'
JSON

Coming soon

Coming soon

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

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

An investor record must reference exactly one investor mastered separately:

  • The investor.investorType field must be either Person or LegalEntity.

  • The investor.investorIdentifiers field must reference one of the user-defined property identifiers for that person or legal entity.

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

Once created, you can call the same UpsertInvestorRecords API again to change any attribute. To delete an investor record, call the DeleteInvestorRecord API and specify one of its user-defined property identifiers.