GLEIF API Changes

The following document outlines the additions to the GLEIF API to incorporate information of the new CDF formats.

This document only provides JsonPath notation to indicate the position of the new attributes within a given lei-records resource. Please refer to the provided API response examples to see the new fields as part of a full JSON response.

New LEI Record Attributes

The following attributes will be added to the lei-records resource:

# EnityCreationDate
entity.creationDate

# SubCategory
entity.subCategory

# Now-repeating SuccessorEntities:**
entity.successorEntities[*].lei
entity.successorEntities[*].name
entity.successorEntities[*].lang

# Entity Events (grouped)
entity.eventGroups[*].groupType
entity.eventGroups[*].events[*].validationDocuments
entity.eventGroups[*].events[*].validationReference
entity.eventGroups[*].events[*].effectiveDate
entity.eventGroups[*].events[*].recordedDate
entity.eventGroups[*].events[*].type
entity.eventGroups[*].events[*].status
entity.eventGroups[*].events[*].affectedFields[*].value
entity.eventGroups[*].events[*].affectedFields[*].xpath

For convenience and consistency, the entity.eventGroups array groups the individual LegalEntityEvent elements from the XML record as indicated by the lei:LegalEntityEvent/@group_id attribute. Events of group_type=STANDALONE will contain only a single event within the events array.

To ensure backwards-compatibility, existing (deprecated) fields will stay unchanged. In the case of successor entities this means that the API will still include the single field entity.successorEntity, which will include information of the first (if any) Successor Entity specified in the LEI record XML.

New LEI Record Relationships

The API response for the lei-records resource will be extended to include additional relationship links. Relationship links will only be included, if the record in question actually has such relationships.

Successor Entities

A new successor-entities (plural) relationship link will be introduced to support the now-repeating SuccessorEntity field.

relationships.successor-entities.links.related

To ensure backwards-compatibility, the existing (now deprecated) relationships.successor-entity link will stay unchanged. If a record has SuccessorEntity LEI codes specified, the first LEI code will be used for the relationship link.

RR Fund Relationships

Analogous to the existing ultimate/direct children/parents, the API will include additional relationship links for all new relationship types introduced with RR CDF 3.1:

• IS_FUND-MANAGED_BY (Fund Manager <--> Managed Funds)
• IS_SUBFUND_OF (Umbrella Fund <--> Sub-Funds)
• IS_FEEDER_TO (Master Fund <--> Feeder Funds)

The API will model the above relationship types in both "directions", as indicated in the parenthesis.

The exact relationship links are listed below. Note that a link will only be present if the given record actually has the relationship declared via a corresponding RR record.

RelationshipType: IS_FUND-MANAGED_BY

relationships.fund-manager.links.lei-record
relationships.fund-manager.links.relationship-record

relationships.managed-funds.links.related
relationships.managed-funds.relationship-records

RelationshipType: IS_SUBFUND_OF

relationships.umbrella-fund.links.lei-record
relationships.umbrella-fund.links.relationship-record

relationships.sub-funds.links.related
relationships.sub-funds.links.relationship-records

RelationshipType: IS_FEEDER_TO

relationships.master-fund.links.lei-record
relationships.master-fund.links.relationship-record

relationships.feeder-funds.links.related
relationships.feeder-funds.links.relationship-records

RR Branch Relationships

In addition to the new RR CDF 3.1 relationship types for funds, the API will also support the RR CDF 2.1 relationship type IS_INTERNATIONAL_BRANCH_OF.

"RelationshipType: IS_INTERNATIONAL_BRANCH_OF

relationships.head-office.links.lei-record
relationships.head-office.links.relationship-record

relationships.branches.links.related
relationships.branches.links.relationship-records