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.
  2. Read or Write Data to Third-party Apps from Refold using API Proxies & Events.
  3. Setup and integration and Build Workflow for your use-case.
  4. Integrate the Refold API or SDK into your application’s backend.
  5. 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.
  6. Optimize and test your application and workflows to maintain a smooth user experience using Refold.
  7. Once your integration has been tested thoroughly, go live with all of your customers.
To get started, contact our Support team here to get account of Refold to receive your test and production environment API Keys and use the Refold APIs.

​
Pre-requisite: Linked Account

Linked Accounts refers to the end-users or customers of our users who utilize the integrations built using the Refold platform and each Linked Account has a unique linked-account-id.
To learn more about Linked Accounts, you can refer to the Linked Accounts Guide here.
Auth tokens and User configurations will be stored against the Linked account id of each user. You will already have a few Sample Linked Accounts in Refold to build and test integrations. If you want to create a Linked Account, you can do so by using the Upsert Linked Account API or the .upsertLinkedAccount() method of the NodeJS SDK.
To learn how you can setup this in your backend implementation, refer here.

​
Implement 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.
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).