When you create an instrument in LUSID, you must specify at least one identifier.
Note: If an identifer you use or need is not in our list, contact us to add it to your LUSID domain.
An identifier is classed as either unique or non-unique:
You must specify at least one unique (market) identifier for an instrument. You can specify more than one.
You can specify multiple non-unique identifiers for an instrument. It may have none.
Note that if you have chosen to partition your LUSID instrument master into scopes, a unique market identifier is only unique within a scope.
Note: LUSID automatically generates a LUSID Instrument ID (or LUID) for every instrument, an internal identifier that is guaranteed to be globally unique (across scopes) and never change. The unique (market) identifier you specify is in addition to this LUID.
When you book a transaction (and certain other types of data) into LUSID, you must specify at least one instrument identifier in your API upsert request. A set of rules governs how LUSID uses unique and non-unique identifiers to automatically resolve ingested data items to instruments.
Unique identifiers
A unique identifier can only be assigned to one instrument in a scope at a time.
For example, if you assign the FIGI unique identifier BBG000C05BD1
to an instrument representing BP PLC $0.25 shares traded in London, LUSID raises an error if you try to assign FIGI BBG000C05BD1
to another instrument in the same scope. You can assign FIGI BBG000C05BD1
to an instrument representing the same financial asset in a different scope.
The following identifier types are unique within a scope (note type names are case sensitive):
LUSID identifier type (case-sensitive) | Example value | Use this identifier to map to... |
|
| |
|
| Your internal security database |
|
| |
|
| |
|
| An ISO 4217 currency |
Non-unique identifiers
A non-unique identifier can be assigned to more than one instrument in any scope at a time.
For example, you could assign the ISIN non-unique identifier GB0007980591
to two instruments in the same scope, one representing BP PLC $0.25 shares traded in London (with the FIGI unique identifier BBG000C05BD1
) and one representing BP PLC $0.25 shares traded in Berlin (with the FIGI unique identifier BBG000K1QR97
). This makes sense because ISIN GB0007980591
represents the BP share class.
The following identifier types are non-unique within a scope (note type names are case sensitive):
LUSID identifier type (case-sensitive) | Example value |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Listing all the available identifiers
You can see the canonical list of all the built-in identifiers (unique and non-unique) available to assign to instruments by calling the GetInstrumentIdentifierTypes API, for example:
curl -X GET "https://<your-domain>.lusid.com/api/api/instruments/identifierTypes"
-H "Authorization: Bearer <your-API-access-token>"