How do I create an investor record?

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.

Methods

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": {
    "scope": "my-investor-record-scope",
    "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",
      "identifiers": {
        "Person/Identifiers/HNWI": "XY10001111"
      }
    }
  }
}'

Data fields and properties

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

Fields

An investor record 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 investor records in the same scope using the same property identifier must have different values for that identifier.

An investor record must reference exactly one investor mastered separately:

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

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

Properties

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.

Subsequent updates

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.