Update Plaid Docs: Rebrand to Sure and add note about delayed OAuth (#13)

Update setting up Plaid Sync docs
- Rebrand to Sure
- Add note about delayed OAuth approval timelines

Signed-off-by: PrplHaz4 <PrplHaz4@users.noreply.github.com>
This commit is contained in:
PrplHaz4
2025-07-28 23:31:34 -04:00
committed by GitHub
parent da3bed8eec
commit 34e775ae95

View File

@@ -4,7 +4,7 @@ Since #2419 will not be merged, I am moving this guide here in the discussions s
> Plaid integration currently only works for Western users. Plaid Production support is not available to European users.
> [!NOTE]
> For Plaid integration your Maybe instance needs to be accessible by the internet behind a domain with working SSL.
> For Plaid integration your Sure instance needs to be accessible by the internet behind a domain with working SSL.
# Setting Up Plaid
@@ -21,7 +21,7 @@ Go to [https://dashboard.plaid.com](https://dashboard.plaid.com) and register fo
1. On the Home page, find the section labeled "Learn how to build with Plaid" and click **Unlock real data**.
2. Enter your real name and phone number.
3. In the description box, write a statement such as:
This is for personal use only on a self-hosted version of the Maybe Finance software. I am only using it to manage my finances, sync my bank accounts, track my spending, and create a budget.
This is for personal use only on a self-hosted version of the Sure Finance software. I am only using it to manage my finances, sync my bank accounts, track my spending, and create a budget.
4. Leave the "Additional products" section **unchecked**.
5. Click **Request Access**.
6. Wait for your request to be approved (this may take more than 24 hours).
@@ -30,10 +30,15 @@ Go to [https://dashboard.plaid.com](https://dashboard.plaid.com) and register fo
### For Banks That **Require OAuth**
> [!NOTE]
> Per Plaid Support as of July 2025, certain banks are seeing extended OAuth approval timelines.
> - Chase Bank: there have been some additional delays, resulting in an updated wait time of roughly 3-4 months
> - Schwab: the manual review process by Schwab can take up to two months to be completed
1. In the left sidebar on the Plaid dashboard, click **Get production access**.
2. Enter your real address.
3. For the business profile, write:
This is for personal use only on a self-hosted version of the Maybe Finance software. I am only using it to manage my finances, sync my bank accounts, track my spending, and create a budget.
This is for personal use only on a self-hosted version of the Sure Finance software. I am only using it to manage my finances, sync my bank accounts, track my spending, and create a budget.
4. Leave the company website field **blank**.
5. Enter your real name, phone number, email address, and date of birth.
6. Click **Next**.
@@ -45,9 +50,9 @@ Go to [https://dashboard.plaid.com](https://dashboard.plaid.com) and register fo
12. Upload any photo as the logo (must be 1024x1024px and under 4MB).
13. Leave the brand color as **#22CCEE**.
14. Set the Website URL to:
https://github.com/maybe-finance/maybe
https://github.com/we-promise/sure
15. In the "Reason for data access" box, enter:
This is for personal use only on a self-hosted version of the Maybe Finance software. I am only using it to manage my finances, sync my bank accounts, track my spending, and create a budget.
This is for personal use only on a self-hosted version of the Sure Finance software. I am only using it to manage my finances, sync my bank accounts, track my spending, and create a budget.
16. Enter your real email address as the support email.
17. Click **Next**.
18. For the "Where do you want to launch?" section, enter your country.
@@ -65,7 +70,7 @@ Go to [https://dashboard.plaid.com](https://dashboard.plaid.com) and register fo
26. Click **Next**.
27. Click **Start Security Practices Questionnaire**.
28. For each question, select **Other - please see comments**, then write in the notes:
This is for personal use only on a self-hosted version of the Maybe Finance software. I am only using it to manage my finances, sync my bank accounts, track my spending, and create a budget.
This is for personal use only on a self-hosted version of the Sure Finance software. I am only using it to manage my finances, sync my bank accounts, track my spending, and create a budget.
29. Click **Next**.
30. Repeat the process from step 28 for each new section of the questionnaire.
31. Continue clicking **Next** and repeating step 28 until the questionnaire is finished.
@@ -74,7 +79,7 @@ Go to [https://dashboard.plaid.com](https://dashboard.plaid.com) and register fo
---
# Setting Up Maybe to Use Plaid
# Setting Up Sure to Use Plaid
1. After your Plaid account is registered, go to [https://dashboard.plaid.com/developers/api](https://dashboard.plaid.com/developers/api) or click **Developers > API** in the sidebar, then click **Configure** next to Allowed redirect URIs.
2. Click **Add new URI**, type your domain, and add `/accounts` at the end (for example: `https://budget.yourdomain.com/accounts`).
@@ -93,8 +98,8 @@ PLAID_ENV: ${PLAID_ENV}
PLAID_SECRET: ENTER_SECRET_KEY_FROM_PLAID_HERE
PLAID_ENV: production # (use 'production' for Full/Limited Production Access, or 'sandbox' for Sandbox Access)
```
8. Restart Maybe.
8. Restart Sure.
---
Once you access your Maybe instance from your domain, you should now see the **Link account** option in the Maybe UI.
Once you access your Sure instance from your domain, you should now see the **Link account** option in the Sure UI.