Disclaimers

Disclaimer data can be used to track long text data used specifically for things like regulatory disclaimers. Each disclaimer has a type (denoted as disclaimerType) to describe what the text is. Disclaimer types need to be created seperately before they are used.

The contents of a disclaimer can be tracked in multiple cultures and can be associated with either a single fund / share class, or against a list of funds or share classes. Culture codes are free form, but the codes used should match those used in other areas of localization, such as translations and format codes. Our preference is to use ISO culture codes such as 'en-GB'.

Creating / Updating Disclaimer Types

Disclaimer types need to be created before disclaimers. The disclaimer type is a unique code used to identify the type while the description is a friendly name. As always, post an empty body to the end point to receive the full, up to date, JSON schema.

The same end point can be used for both inserts and updates.

Service call details.

Parameter Value
End Point https://api.fundpress.io/config/upsertDisclaimerType
Headers X-KSYS-TOKEN
Content Type application/json
HTTP Method POST
Body
{
    "disclaimerType": "perf_disclaimer",
    "description": "Fund Overview"
}

Creating / Updating Disclaimers

A disclaimer requires a disclaimerType, described above, and can contain an array of disclaimers. Each item of the disclaimers array is an object containing a culture and a disclaimer. The culture must be unique within the array.

A generic disclaimer can be created, agnostic of any fund or class, or it can be linked to the fund/class. The linkedEntity field is used to create this association. The value of this field is the clientCode of the fund or class in the FundPress system, and is usually an industry standard identifier such as an ISIN or CUSIP. Note that this value is defined specifically to the individual implementation and is not fixed by fundpress.

If the disclaimer applies to a group of funds/classes, then fund lists can be used. linkedList can be specified, with its value pointing to the name of a pre-created list.

The same end point can be used for both inserts and updates.

Service call details.

Parameter Value
End Point https://api.fundpress.io/config/upsertDisclaimer
Headers X-KSYS-TOKEN
Content Type application/json
HTTP Method POST
Body, linked to single share class
{
    "disclaimerType": "Fund Overview",
    "disclaimers": [
        {
            "culture": "en-GB",
            "disclaimer": "This fund invests in several asset classes and seeks returns..."
        }
    ],
    "linkedEntity": "LU123123123"
}
Body, linked to list of funds
{
    "disclaimerType": "Fund Overview",
    "disclaimers": [
        {
            "culture": "en-GB",
            "disclaimer": "This fund invests in several asset classes and seeks returns..."
        }
    ],
    "linkedList": "etf_equity"
}

Listing Disclaimers

This call allows the user to list disclaimers in the system

Parameter Value
End Point https://api.fundpress.io/config/listDisclaimers
Headers X-KSYS-TOKEN
Content Type application/json
HTTP Method POST

List body

{
    "disclaimerType": ["Fees", "KIID Header"],
    "culture": ["de-DE", "en-GB"]
}

or

{
    "disclaimerType": "Fees",
    "culture": "de-DE",
    "global": true,
    "linkedEntity": ["LU123123123"],
    "linkedList": ["All Funds"],
    "entityType": "FUND"
}
Parameter Required Value
disclaimerType FALSE A single or a list of disclaimer types to filter on
culture FALSE A single or a list of cultures to filter on
global FALSE Whether to only show disclaimers with no linked entities
linkedEntity FALSE A single or a list of entity identifiers
linkedList FALSE A single or a list of segmentation list names
entityType FALSE Filters to linked entities of a specific type

List Response

[
    {
        "disclaimerId": 7,
        "disclaimerType": "Fees",
        "linkedList": "All Funds",
        "clientId": 2,
        "disclaimers": [
            {
                "culture": "en-GB",
                "disclaimer": "Fees rates are shown excluding VAT. TERs are shown including VAT."
            },
            {
                "culture": "de-DE",
                "disclaimer": "Geb├╝hren werden ohne Mehrwertsteuer ausgewiesen. TERs werden inklusive Mehrwertsteuer angezeigt."
            }
        ],
        "disclaimers_draft": [],
        "lastModified": "2018-07-25T08:15:54.000Z",
        "lastModifiedBy": "kurtovest.admin",
        "created": "2018-07-25T08:15:54.000Z",
        "createdBy": "kurtovest.admin",
        "status": "Draft",
        "workflow": {
            "approvedBy": [],
            "rejectedBy": [],
            "status": "Draft"
        },
        "lastPublished": "2018-07-25T08:15:54.000Z",
        "lastPublishedBy": "kurtovest.admin",
        "lastAction": "Published",
        "linkedItem": "All Funds"
    }
]