Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.refold.ai/llms.txt

Use this file to discover all available pages before exploring further.

Follow these simple steps to implement Refold.
  1. Sign up for a free account to receive your credentials and API Keys and understand how Refold simplifies building integrations for you.
  2. Integrate Hosted Portal into your frontend. (Hosted Portal is the user inferface that allows your customers to safely and securely grant your application access to their account.) You can opt to redirect to Refold Hosted Flow or build your own UI using Refold SDKs.
  3. Integrate the Refold API or SDK into your application’s backend.
  4. Read and Write Data to Third-party Apps from Refold.
  5. Optimize and test your application and workflows to maintain a smooth user experience using Refold.
  6. Once your integration has been tested thoroughly, go live with all of your customers.
So let’s get started!!Create your account now.

​
Frontend + Backend

For a full implementation, Refold requires both a frontend and a backend application to exist. The frontend application coordinates connecting the user with various integrations, and the backend server securely manages the requests and responses to and from Refold APIs.

​
Frontend Development

Refold Auth flows lets your users connect their integration accounts. It stores the credentials securely and lets you make authorized API calls on your users’ behalf (linked account in Refold). There are three ways to integrate Refold into your application’s frontend user interface.
  1. Hosted flow: In this method you can effortlessly redirect your users’ to Hosted Portal, which is securely hosted by Refold.
  2. Embedded flow: It is a good option if you want your client team to be responsible for the integration of Hosted Portal into your app. You can use the Hosted Portal JavaScript SDK or the Hosted Portal React SDK to build your own custom UI for Hosted Portal. Both SDKs make it easy to let your users authorize and manage integrations with just a few lines of code.
  3. Seamless flow: If you want your backend team to handle the integration, you can use the Connect API directly to create your own integration experience inside your app.

​
Backend Development

Once the connection has been created via Refold frontend, you can now implement .connect() and .disconnect() function of Refold Client-side SDK to allow your end-users to make or break a connection with the integrations. We offer NodeJS backend SDKs to make the backend integration smoother.