---
title: "How do I create entities under a custom data model?"
slug: "how-do-i-create-entities-under-a-custom-data-model"
updated: 2026-09-04T09:26:05Z
published: 2026-09-04T09:26:05Z
canonical: "support.lusid.com/how-do-i-create-entities-under-a-custom-data-model"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.lusid.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How do I create entities under a custom data model?

You can create entities under (that is, in the context of) a custom data model (CDM) in order to enforce the requirements of that model.

> **Note**: You can continue creating entities outside the context of a CDM if you wish. Providing they meet the requirements, you can [induct them](/v1/docs/managing-membership-of-custom-data-models) later.

If an entity is updated such that it no longer meets the requirements, LUSID updates the membership status. You can [manually remove](/v1/docs/managing-membership-of-custom-data-models) invalid entities from the CDM.

LUSID web appLUSID APILuminesce

Call an API such as [UpsertInstruments](https://www.lusid.com/docs/api/lusid/endpoints/instruments/UpsertInstruments/) API and supply the `dataModelScope` and `dataModelCode` of the CDM to use as query parameters in the URL, for example:

```json
curl -X POST "https://<your-domain>.lusid.com/api/api/instruments?dataModelScope=CDMs&dataModelCode=Equities"
   -H "Authorization: Bearer <your-API-access-token>"
   -H "Content-Type: application/json"
   -d '{"upsert-request-1": {
    "name": "BP $0.25 LDN",
    ...
  }
}'
```

We strongly recommend checking the `failed` object in the response for entities that did not meet the requirements:

```json
{
  "values": {},
  "staged": {},
  "failed": {
    "upsert-request-1": {
      "id": "upsert-request-1",
      "type": "CustomDataModelValidationFailure",
      "detail": "Mandatory Custom Data Model Identifier 'Instrument/default/Figi' was not provided",
      "errorDetails": []
    }
  },
  ...
}
```

Navigate to the dashboard for the entity type of interest, for example **Data Management > Instruments**, and select a CDM:

![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/image-JKIUX38I.png?sv=2026-02-06&spr=https&st=2026-11-09T06%3A42%3A13Z&se=2026-11-09T07%3A42%3A13Z&sr=c&sp=r&sig=%2FOU1ITBtC%2Fud1d3LLRibT21Shq%2FzHGdqh2pRcfQk9tA%3D)

Make sure the breadcrumb trail identifies the correct CDM (highlighted below) and click the **Create instrument** button:

![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/image-MRXRHKR2.png?sv=2026-02-06&spr=https&st=2026-11-09T06%3A42%3A13Z&se=2026-11-09T07%3A42%3A13Z&sr=c&sp=r&sig=%2FOU1ITBtC%2Fud1d3LLRibT21Shq%2FzHGdqh2pRcfQk9tA%3D)

Note that the first `Instruments` item in the breadcrumb trail above represents standard instruments created outside the context of a model, with no restrictions on identifiers and properties.

Complete the **Create instrument** dialog in the normal way. Note the **M** icon before the name depicts identifiers and properties controlled by the CDM, and the ***** after it signifies that values are mandatory:

![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/image-IH68OQS0.png?sv=2026-02-06&spr=https&st=2026-11-09T06%3A42%3A13Z&se=2026-11-09T07%3A42%3A13Z&sr=c&sp=r&sig=%2FOU1ITBtC%2Fud1d3LLRibT21Shq%2FzHGdqh2pRcfQk9tA%3D)

***Coming soon***