Set Up a Custom API Integration

ℹ️

Custom integrations only

This page explains how to set up custom integrations that use a direct API connection. If you are using Flinks Connect, see Set Up Flinks Connect.

Complete the following steps to connect with us using a custom API integration that uses OAuth 2.0.

1. Ask your Flinks Representative to whitelist the URLs that your endpoints will be calling, including the redirect URL in step 2ii.

2. Call the /OAuth/Authorize endpoint and perform the following tasks:

   1. Redirect the end-user to their bank’s login screen using the institution parameter. Here, they’ll enter their login credentials and complete multi-factor authentication (MFA) if required.

   2. Provide a URL to direct the end-user’s screen back to your website or app using the redirect_uri field.
      If the login is successful, you’ll receive a redirect response that contains the redirect URL, a loginId:

      JSON

      https://{redirect}?loginId={loginId}&state={state}
      

      If unsuccessful, you’ll receive a redirect response that contains a redirect URL and an error message:

      JSON

      https://{redirect}?state={state}&error={error}&error_description={error_description}
      

   For more information about how to make this call, see our API documentation.

3. Call the/Authorize endpoint and apply the following settings to initiate the authorization flow:

   1. Pass the loginId that you received in step 2.
      
      
   2. Make the call in live mode by setting the MostRecentCached parameter to FALSE.
      For more information about how to make this call, see our API documentation.
      
      
   3. Set the save parameter to TRUE to maintain communication with the database (to do nightly refreshes, receive insights and more).
      
      For more information about how to make this call, see our API documentation.

4. If you receive a 200 response, the end-user is successfully authenticated and you can now use Flinks APIs to retrieve data.