---
updatedAt: 2025-09-24T23:13:47.000Z
agentTools:
  projectIndex: https://techdocs.fundapps.co/llms.txt
---

# Getting Started

Authenticating & Configurating the Data Adapter Service

> 📘 With minimum data points, positions will be sent in CSV format to Data Adapter, where Data Adapter enriches the file with market data from your chosen data provider, generates a complete XML file and transmits it to FundApps.

## Authentication

Authentication to the Data Adapter API is done via [Basic Authentication](https://tools.ietf.org/html/rfc2617) over HTTPS. An administrator from your organisation must create a user with the role "API" for this purpose. You must authenticate for all requests.

**Note:** Please ensure you create a separate user for the API as if you use an existing user's account, as soon as they change their password the API upload will fail.

**Your base URL** for Data Adapter is <https://%company%-svc.fundapps.co/api/adapptr>,

e.g. `https://abc-svc.fundapps.co/api/adapptr`

## Creating an API User

Setting up a user with the API user role in your FundApps environment is the first step to authenticating with our services. You can follow instructions [here](https://support.fundapps.co/hc/en-us/articles/201954297-Creating-Editing-and-Managing-Users) on how to set up an API user if this has not been done already.

On creation, an email will be sent to the email address given for the API user. The email address provided must be a real email address and have an accessible inbox - we recommend using a support

> 🚧 API users are not able to log in to the UI - please do not use the email address of a UI user.

❗Note: If the password for an API user is changed and this update is not captured in authentication method, it may lead to error 401 for unauthorised user.

***

# Configuration

## Available Nomenclatures `GET /v2/nomenclatures`

List of available data providers, identifier types, position services and more. Those can be requested from this endpoint. You must then use the appropriate ids for parameters in other requests.

| Id | Data Provider |
| -- | ------------- |
| 1  | Refinitiv     |
| 2  | Bloomberg     |

| Id | Identifier Type |
| -- | --------------- |
| 1  | Isin            |
| 2  | Sedol           |
| 3  | Cusip           |
| 4  | DataProviderId  |

| Id | Positions Service                         |
| -- | ----------------------------------------- |
| 2  | Shareholding Disclosure                   |
| 4  | Position Limits                           |
| 6  | Shareholding Disclosure & Position Limits |

| Id | File Data Formats |
| -- | ----------------- |
| 1  | FundApps          |
| 2  | Consensys         |

## Data Provider Credentials

> ℹ️ Please note that data provider credentials can now be set in the UI, for both Bloomberg and Refinitiv. This functionality can be found in the Data Provider Settings panel, located on the Position Uploads page.

`POST /v2/configuration/dataproviders/:providerId/credentials`

**Refinitiv**\
If you are using Refinitiv data you must submit your username and password to this endpoint. Before being able to post a file to Data Adapter, your data provider credentials must be set. Your file upload will otherwise fail because FundApps will be unable to connect and authenticate against the data provider.

**Bloomberg**\
This endpoint does not support Bloomberg data provider. The support team will use your Bloomberg generated certificate to enable Data Adapter integration. Please contact `support@fundapps.co` or your Implementation Manager for more details.

e.g.\
`{ "Username": "[Username]", "Password": "[Password]" }`

## Updating run parameters via configuration UI

### Configuration

You can now view and update the run parameters for Data Adapter in the Data Provider Settings Panel. The options which are displayed in the dropdown boxes are the client's current configuration. After clicking "Save" you should see a message confirming the parameters have been updated on the bottom left corner of the page and the updated configuration will be displayed on the page. All following Data Adapter runs will use the updated parameters.

The default configuration is as follows:

| Parameter                            | Value |
| :----------------------------------- | :---- |
| Primary Identifier                   | ISIN  |
| Secondary Identifier                 | None  |
| Tertiary Identifier                  | None  |
| Copy Down Parent Instrument Data     | False |
| Exclude Errored Assets               | False |
| Exclude Duplicated Assets            | False |
| Populate Execution Venue With Market | False |

Please note: the v2 endpoint will still accept configuration options and set the latest configuration for Data Adapter until it is decommissioned. Using the v2 endpoint may override any settings set through the UI.

Please refer to the [permissions matrix](https://support.fundapps.co/en/articles/239918-roles-users-privilege-model) to see the user roles that can see and edit this "Global Settings" configuration

### Credentials

You can now upload Data Provider credentials in the Data Provider Settings on the Position Uploads Page. Credentials must be provided before running a file though the Data Adapter, otherwise the file run will fail.

**Refinitiv**

If you are using Refinitiv data you must submit your username and password. Refinitiv resell clients do not need to upload credentials.

**Bloomberg**

If you are using Bloomberg you can upload the Bloomberg certificate and password though the UI.