Documentation for a newer release is available. View Latest

Party Entity Directory

Party Entity Directory is a dynamic configuration that can be used to look up Party Entities to retrieve the party entity details like identifiers and address details.

The data returned from party entity look up can be used by client implementations for payment enrichment purposes. The directory is also used during reachability check to look up identifiers used by CSM Agents for participation when the input request does not provide required identifier type.

Party Entity Directory supports ingestion from Industry reference data to enable entity look-ups.

IPF supports below industry file ingestion into Party Entity Directory: In future more data sources can be supported on Party Entity Directory if a need is identified through client requirements.

If required, client implementations can also define and implement custom ingestion into Party Entity Directory.

Sr. No. Industry Data File Industry Source File Format File Type (Full / Delta)

1

Bank Directory Plus

SWIFTRef

XML

Full, Delta

2

SIX Bank Master 3.0

SIX

XML

Full

Party Entity Directory Data Structure

Similar to CSM Participants, Party Entity Directory is a generic dynamic configuration that is loaded through different industry sources in a generic way, irrespective of the format of source industry files.

Below are the properties supported on Party Entity Directory.

Party Entity Directory property Description

entityUniqueId

A unique ID by which the entity will be known. The ID will be unique across the data source.

entityDataSource

Specifies the source of the data, which can be a certain reference data source, such as 'Bank_Directory_Plus' or 'Bank_Master'.

entityType

Type of the Party Entity. Possible values are 'Bank' or 'Branch'. This is for information purposes only and not used during processing.

entityName

Name of Party entity.

entityAddress

Address of Party entity. The address fields on Party Entity Directory records follow ISO20022 compliant address structure.

entityEmail

Email of Party Entity. Supports special characters.

entityPhoneNumber

Phone number of Party Entity. Supports special characters

entityIdentifiers

A list of identifiers associated with the entity. The Identifier types supported are BIC, NCC (National Clearing Code) and LEI.

isHeadOffice

Indicates if the entity is a head office entity in the group.

Refer to below page to know more about payment identifiers used on IPF CSM Reachability Service.

Important points to note about Party Entity Directory:

  1. All the BICs provided by the industry data sources are loaded as ACCOUNT_ISSUING_BIC on party entity directory.

  2. The National Ids provided by industry data sources are loaded as NCCs and subtype definitions are loaded as per the industry data source. Where available, the subtype information aligned with ISO20022 aligned 'External Clearing Codes' is also loaded.

  3. Party Entity Directory is not meant to be used for checking membership to schemes or participation to CSM Agents. For this purpose, CSM Participant dynamic configuration is used.

Setting Type

DPS v2 introduced new attribute of Setting Type. This is used for generation of all API endpoints for a particular setting. It is also used in index-config.<setting type> construct. SETTING_TYPE = "partyentity"

Searchable Fields

Searchable fields for Party Entity Directory are:

  • identifier

  • identifierType

  • identifierSubType

  • country

  • entityDataSource

Indexes

DPS v2 provides an option to configure indexes for each setting. Default indexes for Party Entity Directory are:

ipf.dps.mongodb.index-config.partyentity {
    index-1 = ["status:ASC"]
    index-2 = ["source:ASC"]
    index-3 = ["values.payload.entityIdentifiers.identifier:ASC"]
    index-4 = ["values.payload.entityIdentifiers.identifierType:ASC"]
    index-4 = ["values.payload.entityIdentifiers.identifierSubType:ASC"]
    index-5 = ["values.payload.entityAddress.country:ASC"]
    index-5 = ["values.payload.entityDataSource:ASC"]
  }

This can be overridden or updated. Just note that when the field is under payload, you need to provide an index like: index-x = ["values.payload.fieldX:ASC"].

Notifications

DPS v2 can provide notification after certain CRUD operation on a setting is performed. There is an option to enable notifications on setting level. Notifications are disabled by default:

ipf.csm-reachability.should-send-notification.party-entity-settings = false

History

There is an option to disable history on setting level. History is enabled by default:

ipf.csm-reachability.should-save-history.party-entity-settings = true

Party Entity Directory Mappings

Party Entity Directory mapping supports two types of ingestion files: