The below information is for non-Adapptr clients. If you want to read more on how to authenticate via Adapptr, please see here.

Authenticating With User Credentials

FundApps authorised endpoints require the credentials of an authorised user. By default, FundApps API resources will require the Basic credentials of a user with the API user role. To see our full privilege matrix, see our Zendesk help page.

📘

Some services may use a different authentication strategy - this will be documented in both the Guides section & the API reference.

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 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.

Using Credentials

Basic Credentials

For all resources with Basic credentials defined as an authentication method, you must included your email and password in the format email:password encoded in Base64. The header included with the request should be in the format:

authorization: Basic ZW1haWxAZW1haWwuY29tOnBhc3N3b3Jk

// Code Example
var client = new RestClient("{endpoint}");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "Basic ZW1haWxAZW1haWwuY29tOnBhc3N3b3Jk");
IRestResponse response = client.Execute(request);

📘

This will apply to all endpoints with Basic authentication declared in the API Reference

Bearer Credentials

For some products/services, we use Bearer credentials. This will be a token issued via a specified endpoint (e.g. /token) for the given API. In the case of some products, we offer both Basic and Bearer credentials as options for authentication, to allow ease of testing with Basic credentials and faster integrations with Bearer credentials.

To attach Bearer credentials to a request, include the credentials in the authorization header, as in the example below:

authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

// The below is a stub token - this will need to be retrieved first
var token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
var client = new RestClient($"{endpoint}");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", $"Bearer {token}");
IRestResponse response = client.Execute(request);