Skip to main content

Intermediaries

Intermediaries are data recipients who register apps to consume your APIs.

From the intermediaries feature, you can access a list of all intermediaries (in other words, aggregators) that have been added to connect to your institution. The list shows the intermediary’s name, status, request limit, and how many apps are registered with it. You can select an intermediary to see information about it and all apps that have been registered with it.

intermediaries

Add an Intermediary​

To add an intermediary:

  1. Select +Add.
  2. Enter the following info about the intermediary:
    • Logo
    • Name
    • Adjust the intermediary's status if needed.
      • When set to Enabled, all API requests flow freely to this intermediary and their registered apps.
      • When set to Disabled, all API requests from this intermediary and their registered apps will be rejected.
      • When set to Needs review, all API requests from this intermediary will be rejected, and notes that the intermediary’s apps and settings need to be reviewed before enabling.
    • The website, support email, support phone, address**, city, state, and zip fields are optional. These fields help other team members identify the intermediary and who to contact if support is needed.
  3. Set a request limit and frequency.
    • If the intermediary exceeds the request limit, any more requests will be blocked. If you don’t want to set a request limit, select the Disable request limit checkbox.
    • Tip: A request is counted each time one of the FDX endpoints is hit. For example, GET /accounts would be one request.
  4. Select whether any new apps that are registered with the intermediary are auto-approved or not. If this is set to manual, the data provider admin will have to manually enable each newly registered app.
  5. Enter the IP addresses for the intermediary.
    • You can add multiple addresses if needed.
  6. When the form is complete, select Add.

intermediaries

After the intermediary has been added, select it from the list. In the Intermediary Info column, you will find the app registration key. Send this key back to the intermediary to enable them to use the dynamic client registration endpoint.

Invite an Intermediary Admin​

You can give Data Recipient Portal access to intermediary admins by sending them an email invite and setting their role correctly.

To invite an intermediary admin:

  1. From the intermediary details page, find the TEAM MEMBERS section and select Edit.
  2. Select Add team members.
  3. Enter the intermediary admin's first name and last name.
  4. From the Role dropdown, select Intermediary Admin.
    • Intermediary admins have full edit access to all features of the Data Recipient Portal, whereas users have read-only access.
  5. Enter a work email.
  6. Select Add.

Once added, an email will be sent to the specified intermediary admin inviting them to set a password and log in to the Data Recipient Portal.

Remote App Registration Keys​

If an intermediary’s app registration key is compromised, or if your security and compliance team requires these keys be rotated regularly:

  1. Select •••.
  2. Select Rotate key.

The new key will need to be sent back to the intermediary in order for them to register any new apps or update existing apps.

Enable an Intermediary​

If an intermediary’s status is set to Enabled, all API requests that come from that intermediary and its registered apps will be accepted.

To enable an intermediary:

  1. Select the intermediary you want to enable.
  2. Select Enable.

Add an App to an Intermediary​

We suggest that intermediaries use dynamic client registration to register their apps. However, the data provider admin might need to add an app on behalf of an intermediary, so you can also manually register apps via the Data Provider Portal.

To add an app to an intermediary:

  1. Select the intermediary you want to add the app to.
  2. From the intermediary details page, select +Add an app.
  3. Enter the name of the app.
  4. Adjust the status if needed.
  5. Enter the redirect URI (you must get this from the intermediary or app).
  6. Select an app category. Choose from the existing categories or create a new one.
  7. When the form is complete, select Save.

After the app has been added, select it from the list. In the App Info column you will find the app’s client ID and client secret. These need to be sent back to the intermediary.

On this page