PartyCreationRequestV01

reda.014.001.01

Scope: The PartyCreationRequest message is sent by an instructing party to the executing party to request for the creation of party reference data for a new party in the executing system.

Usage: It aims at instructing the creation of a new party with corresponding details. Processing and confirmation of the party creation request are provided via a party status advice.

Message Construction

Every ISO20022 message has at the highest level what we call ‘building blocks’. Because the message is constructed as immutable records, the association is by composition. Below you can see the relationship between the message and its constituent building blocks: For comparison, see the ISO20022 official specification

classDiagram
     direction LR
%% PartyCreationRequestV01 recursion level 0 with max 0
PartyCreationRequestV01 *-- "0..1" MessageHeader1 : MessageHeader
PartyCreationRequestV01 *-- "1..1" SystemParty4 : Party
PartyCreationRequestV01 *-- "0..1" SupplementaryData1 : SupplementaryData

Now, we will zero-in one-by-one on each of these building blocks.

MessageHeader building block

Common business identification for the message. Set of characteristics, such as the identification or the creation date and time, specific to the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageHeader1 recursion level 0 with max 1
class MessageHeader1{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}

MessageHeader1 members

Member name	Description	Data Type / Multiplicity
MessageIdentification	Point to point reference, as assigned by the sender, to unambiguously identify the message. Usage: The sender has to make sure that MessageIdentification is unique for a pre-agreed period.	IsoMax35Text - Required 1..1
CreationDateTime	Date and time at which the message was created.	IsoISODateTime - Optional 0..1

Party building block

Specifies the details of the party to be created in the system. Provides the definition of a party within a system. A party shall denote any legal or organisational entity required in the system. This entity shall store the parties from the first three levels: the system operator, the central securities depositaries, the participants of the central securities depositaries, the national central banks and payment banks. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SystemParty4 recursion level 0 with max 1
class SystemParty4{
    OpeningDate IsoISODate
    ClosingDate IsoISODate
    ResidenceType ResidenceType1Code
}
SystemParty4 *-- "1..1" SystemPartyIdentification9 : PartyIdentification
SystemParty4 *-- "0..0" PostalAddress25 : Address
SystemParty4 *-- "0..0" Contact5 : ContactDetails
SystemParty4 *-- "1..1" ISystemPartyType1Choice : Type
SystemParty4 *-- "0..0" ITechnicalIdentification2Choice : TechnicalAddress
SystemParty4 *-- "0..0" MarketSpecificAttribute1 : MarketSpecificAttribute
SystemParty4 *-- "0..1" PartyName4 : Name
SystemParty4 *-- "0..1" PartyLockStatus1 : LockStatus
SystemParty4 *-- "0..0" SystemRestriction1 : Restriction
%% SystemPartyIdentification9 recursion level 1 with max 1
class SystemPartyIdentification9{
    ValidFrom IsoISODate
}
SystemPartyIdentification9 *-- "1..1" PartyIdentification136 : Identification
SystemPartyIdentification9 *-- "0..1" PartyIdentification136 : ResponsiblePartyIdentification
%% PostalAddress25 recursion level 1 with max 1
class PostalAddress25{
    Department IsoMax70Text
    SubDepartment IsoMax70Text
    StreetName IsoMax70Text
    BuildingNumber IsoMax16Text
    BuildingName IsoMax35Text
    Floor IsoMax70Text
    PostBox IsoMax16Text
    Room IsoMax70Text
    PostCode IsoMax16Text
    TownName IsoMax35Text
    TownLocationName IsoMax35Text
    DistrictName IsoMax35Text
    CountrySubDivision IsoMax35Text
    Country CountryCode
    AddressLine IsoMax70Text
    ValidFrom IsoISODate
}
PostalAddress25 *-- "0..1" IAddressType3Choice : AddressType
%% Contact5 recursion level 1 with max 1
class Contact5{
    NamePrefix NamePrefix2Code
    Name IsoMax140Text
    PhoneNumber IsoPhoneNumber
    MobileNumber IsoPhoneNumber
    FaxNumber IsoPhoneNumber
    EmailAddress IsoMax2048Text
    EmailPurpose IsoMax35Text
    JobTitle IsoMax35Text
    Responsibility IsoMax35Text
    Department IsoMax70Text
    PreferredMethod PreferredContactMethod1Code
    ValidFrom IsoISODate
    ValidTo IsoISODate
}
Contact5 *-- "0..0" OtherContact1 : Other
%% ISystemPartyType1Choice recursion level 1 with max 1
%% ITechnicalIdentification2Choice recursion level 1 with max 1
%% MarketSpecificAttribute1 recursion level 1 with max 1
class MarketSpecificAttribute1{
    Name IsoMax35Text
    Value IsoMax350Text
}
%% PartyName4 recursion level 1 with max 1
class PartyName4{
    ValidFrom IsoISODate
    Name IsoMax350Text
    ShortName IsoMax35Text
}
%% PartyLockStatus1 recursion level 1 with max 1
class PartyLockStatus1{
    ValidFrom IsoISODate
    Status LockStatus1Code
    LockReason IsoMax35Text
}
%% SystemRestriction1 recursion level 1 with max 1
class SystemRestriction1{
    ValidFrom IsoISODateTime
    ValidTo IsoISODateTime
    Type IsoMax35Text
}

SystemParty4 members

Member name	Description	Data Type / Multiplicity
PartyIdentification	Unique identification of the party within the system.	SystemPartyIdentification9 - Required 1..1
Address	Information that locates and identifies a specific address.	PostalAddress25 - Unknown 0..0
ContactDetails	Specifies the options on how to contact the party.	Contact5 - Unknown 0..0
OpeningDate	Specifies the opening date of the party.	IsoISODate - Optional 0..1
ClosingDate	Specifies the closing date of the party.	IsoISODate - Optional 0..1
Type	Specifies the type classification of the party.	ISystemPartyType1Choice - Required 1..1
TechnicalAddress	Unique technical address to unambiguously identify a party for receiving messages from the executing system.	ITechnicalIdentification2Choice - Unknown 0..0
MarketSpecificAttribute	Additional attributes defined by a central security depositary for a party.	MarketSpecificAttribute1 - Unknown 0..0
Name	Name by which a party is known and which is usually used to identify that party.	PartyName4 - Optional 0..1
ResidenceType	Specifies the type of residence where the party has its permanent home or principal establishment.	ResidenceType1Code - Optional 0..1
LockStatus	Specifies whether the party is locked or not, and the reason for this status, when required.	PartyLockStatus1 - Optional 0..1
Restriction	Defines the specific processing characteristics for a party to ensure configurability of specific requirements, as prescribed by national legal and regulatory requirements and practices.	SystemRestriction1 - Unknown 0..0

SupplementaryData building block

Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1

SupplementaryData1 members

Member name	Description	Data Type / Multiplicity
PlaceAndName	Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath.	IsoMax350Text - Optional 0..1
Envelope	Technical element wrapping the supplementary data.	IsoSupplementaryDataEnvelope1 - Required 1..1

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the PartyCreationRequestV01 implementation follows a specific implementaiton pattern. First of all, PartyCreationRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, PartyCreationRequestV01Document implements IOuterDocument. Because PartyCreationRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type PartyCreationRequestV01.

classDiagram
    class IOuterRecord
    PartyCreationRequestV01 --|> IOuterRecord : Implements
    PartyCreationRequestV01Document --|> IOuterDocument~PartyCreationRequestV01~ : Implements
    class IOuterDocument~PartyCreationRequestV01~ {
        PartyCreationRequestV01 Message
     }

Document wrapper for serialization

The only real purpose PartyCreationRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:reda.014.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using PartyCreationRequestV01.ToDocument() method. The returned PartyCreationRequestV01Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    PartyCreationRequestV01Document *-- PartyCreationRequestV01 : Document

Sample of message format

This is an abbreviated version of what the message should look like.

<Document xmlns="urn:iso:std:iso:20022:tech:xsd:reda.014.001.01">
    <PtyCreReq>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <Pty>
            <!-- Party inner content -->
        </Pty>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </PtyCreReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_lfqucZeTEeen_cyMrluY4w"
  name="PartyCreationRequestV01"
  definition="Scope:&#xA;The PartyCreationRequest message is sent by an instructing party to the executing party to request for the creation of party reference data for a new party in the executing system.&#xA;&#xA;Usage:&#xA;It aims at instructing the creation of a new party with corresponding details.&#xA;Processing and confirmation of the party creation request are provided via a party status advice."
  registrationStatus="Registered"
  messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
  xmlTag="PtyCreReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_c7obABivEeiGdqyppFhcBA"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="MsgHdr"
    complexType="_75DzkaMgEeCJ6YNENx4h-w_-613853819" />
  <messageBuildingBlock
    xmi:id="_H_lCYBiwEei5IMHVES5gUw"
    name="Party"
    definition="Specifies the details of the party to be created in the system."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Pty"
    complexType="_-ojlcRirEeiNm9ItaZcR2A" />
  <messageBuildingBlock
    xmi:id="_lfque5eTEeen_cyMrluY4w"
    name="SupplementaryData"
    definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SplmtryData"
    complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
  <messageDefinitionIdentifier
    businessArea="reda"
    messageFunctionality="014"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.