Definition
The PartyEntitlementsRequest message is used to request for entitlement information for one or more party(-ies), specific party role(s), or specific instruments(s).
Message structure 96 distinct fields
Source order, including nested components and groups. Group counts precede the repeated entries. “Required here” is relative to the enclosing component or group, not unconditional in the message. A dash means not marked required; conditional requirements remain in the source notes. This is a reference, not a counterparty-specific validator.
StandardHeaderComponentRequired
MsgType = CU
StandardHeader definition & usage →
FIX session profile (Always unencrypted, must be first field in message)
(Always unencrypted, must be second field in message)
(Always unencrypted, must be third field in message)
Indicates application version using a service pack identifier. The ApplVerID applies to a specific message occurrence.
Used to support bilaterally agreed custom functionality
(Always unencrypted)
(Always unencrypted)
Trading partner company ID used when sending messages via a third party (Can be embedded within encrypted data section.)
Trading partner company ID used when sending messages via a third party (Can be embedded within encrypted data section.)
Required to identify length of encrypted section of message. (Always unencrypted)
Required when message body is encrypted. Always immediately follows SecureDataLen field.
(Can be embedded within encrypted data section.)
(Can be embedded within encrypted data section.)
Sender's LocationID (i.e. geographic location and/or desk) (Can be embedded within encrypted data section.)
"ADMIN" reserved for administrative messages not intended for a specific user. (Can be embedded within encrypted data section.)
Trading partner LocationID (i.e. geographic location and/or desk) (Can be embedded within encrypted data section.)
Trading partner SubID used when delivering messages via a third party. (Can be embedded within encrypted data section.)
Trading partner LocationID (i.e. geographic location and/or desk) used when delivering messages via a third party. (Can be embedded within encrypted data section.)
Trading partner SubID used when delivering messages via a third party. (Can be embedded within encrypted data section.)
Trading partner LocationID (i.e. geographic location and/or desk) used when delivering messages via a third party. (Can be embedded within encrypted data section.)
Always required for retransmitted messages, whether prompted by the sending system or as the result of a resend request. (Can be embedded within encrypted data section.)
Required when message may be duplicate of another message sent under a different sequence number. (Can be embedded within encrypted data section.)
(Can be embedded within encrypted data section.)
Required for message resent as a result of a ResendRequest. If data is not available set to same value as SendingTime (Can be embedded within encrypted data section.)
Required when specifying XmlData to identify the length of a XmlData message block. (Can be embedded within encrypted data section.)
Can contain a XML formatted message block (e.g. FIXML). Always immediately follows XmlDataLen field. (Can be embedded within encrypted data section.)
See Volume 1: FIXML Support
Type of message encoding (non-ASCII characters) used in a message's "Encoded" fields. Required if any "Encoding" fields are used.
The last MsgSeqNum value received by the FIX engine and processed by downstream application, such as trading system or order routing system. Can be specified on every message sent. Useful for detecting a backlog with a counterparty.
HopGrpRepeating groupCount tag 627—
Number of repeating groups of historical "hop" information. Only applicable if OnBehalfOfCompID is used, however, its use is optional. Note that some market regulations or counterparties may require tracking of message hops.
RequestingPartyGrpRepeating groupCount tag 1657—
May be used to identify the party making the request and their role.
RequestingPartyGrp definition & usage →
Required when NoRequestingPartyIDs > 0.
Required when NoRequestingPartyIDs > 0.
Required when NoRequestingPartyIDs > 0.
RequestingPartySubGrpRepeating groupCount tag 1661—
RequestingPartySubGrp definition & usage →
Required when NoRequestingPartySubIDs > 0.
Required when NoRequestingPartySubIDs > 0.
PartiesRepeating groupCount tag 453—
Scope of the query/request for specific party(-ies).
Repeating group below should contain unique combinations of PartyID, PartyIDSource, and PartyRole
Required if NoPartyIDs(453) > 0.
Identification of the party.
Required if NoPartyIDs(453) > 0.
Used to identify classification source.
Required if NoPartyIDs(453) > 0.
Identifies the type of PartyID(448).
PtysSubGrpRepeating groupCount tag 802—
Repeating group of Party sub-identifiers.
PtysSubGrp definition & usage →
RequestedPartyRoleGrpRepeating groupCount tag 1508—
Scope of the query/request for specific party roles. For example, "all information for PartyRole=24".
RequestedPartyRoleGrp definition & usage →
Identifies the type of party role requested. Required if NoRequestedPartyRoles > 0.
EntitlementTypeGrpRepeating groupCount tag 2345—
EntitlementTypeGrp definition & usage →
Number of Entitlement Types.
Required if NoEntitlementTypes(2345) > 0.
InstrumentScopeGrpRepeating groupCount tag 1656—
Scope of the query/request for specific securities.
InstrumentScopeGrp definition & usage →
Required when NoInstrumentScopes > 0.
InstrumentScopeComponent—
InstrumentScope definition & usage →
InstrumentScopeSecurityAltIDGrpRepeating groupCount tag 1540—
InstrumentScopeSecurityAltIDGrp definition & usage →
Required when NoInstrumentScopeSecurityAltID > 0.
Required when NoInstrumentScopeSecurityAltID > 0.
Can be used to specify FX tenors.
MarketSegmentScopeGrpRepeating groupCount tag 1310—
MarketSegmentScopeGrp definition & usage →
Required if NoMarketSegments(1310) > 0.
StandardTrailerComponentRequired
StandardTrailer definition & usage →
Required when trailer contains signature. Note: Not to be included within SecureData field
Note: Not to be included within SecureData field
(Always unencrypted, always last field in message)