API Reference

Authentication

When making requests to the Fuse API, you will need to pass proper authentication parameters so that you can identify yourself as an authorized user.

You will authenticate yourself using a Client Id and API key. To retrieve this, please contact us.

Add your Client Id and API key in your request headers to authorize your Fuse API requests. This header must be included in every request in this format, as well as headers for any financial aggregator you would like to support.

🚧

MX IP Addresses Whitelist

To use MX in production with Fuse, you need to whitelist a set of IP addresses provided by Fuse. Please reach out to the Fuse team to retrieve these IPs.

Header name Header description
Fuse-Client-Id Your fuse client id. Please reach out to Fuse to get this
Fuse-Api-Key Your fuse api key. Please reach out to Fuse to get this.
Plaid-Client-Id Your plaid secret. This can be found in your plaid dashboard under "Team Settings" -> "Keys"
Plaid-Secret Your plaid secret. This can be found in your plaid dashboard under "Team Settings" -> "Keys"
Teller-Application-Id Your teller application id. This can be found in your teller dashboard under "Application" at the top of the page.
Teller-Signing-Secret Your teller signing secret. This can be found in your teller dashboard under "Application" in the "Webhooks" section. This is used for webhook verification and you will only see it if you have webhooks enabled with Teller.
Teller-Certificate Go to your Teller dashboard. Go to certificates and click "Create a new certificate". This will download a zip folder containing your certificate and private key. Run the following command to get a base64 encoded string of your certificate to pass in to this header:
base64 -in certificate.pem 
Teller-Private-Key Run the following command to get a base64 encoded string of your private key to pass in to this header:
base64 -in private_key.pem 
Mx-Client-Id Your mx client id. This can be found in your MX dashboard under "Developers" -> "API keys".
Mx-Api-Key Your mx api key. This can be found in your MX dashboard under "Developers" -> "API keys".

If you’re using the Fuse SDK in your backend to communicate with Fuse, you will add your API key as a parameter during your Fuse client initialization.

🚧

Keep your keys secure

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

In order to utilize our service, you will need to retrieve the necessary credentials for each data aggregator you wish to support. Our team is available to assist you with this process and can also handle it on your behalf. Please note that as we do not store API keys, you will need to include the API key for each aggregator in the corresponding request.

curl --location --request POST 'https://sandbox-api.letsfuse.com/path' \
--header 'fuse-api-key: my-fuse-api-key' \
--header 'fuse-client-id: my-fuse-client-id' \
--header 'plaid-client-id: my-plaid-client-id' \
--header 'plaid-secret: my-plaid-secret' \
--header 'teller-application-id: my-teller-application-id' \
--header 'teller-certificate: my-teller-certificate' \
--header 'teller-signing-secret: my-teller-signing-secret' \
--header 'teller-private-key: my-teller-private-key' \
--header 'mx-api-key: my-mx-api-key' \
--header 'mx-client-id: my-mx-client-id' \
--header 'Content-Type: application/json' \
--data-raw '{}'
import {Environment, FuseApi} from "fuse-node";

const fuseApi = new FuseApi({
    basePath: Environment.SANDBOX,
    fuse: {
        apiKey: "my-fuse-api-key",
        clientId: "my-fuse-client-id"
    },
    plaid: {
        clientId: "my-plaid-client-id",
        secret: "my-plaid-secret"
    },
    teller: {
        applicationId: "my-application-id",
        certificate: "my-certificate",
        privateKey: "my-private-key",
        tokenSigningKey: "my-token-signing-key",
        signingSecret: "my-signing-secret"
    },
    mx: {
        apiKey: "my-api-key",
        clientId: "my-client-id"
    }
});