Embedded Integration
The Embedded Integration lets partners surface Tidely's UI directly inside their own
application via an iframe. End users never leave the partner's product, but get the full
Tidely experience — financial planning, cash flow forecasting, bank account views — backed
by the same data they would see at app.tidely.com.
There are two parts to an embedded integration:
- Partner SSO — your backend obtains a short-lived init token for a specific Tidely user and you hand it to the iframe. Tidely's frontend exchanges the init token for a regular access/refresh token pair. The user is logged in without ever seeing a Tidely login screen.
- Frontend Messaging — your parent page and the embedded
Tidely page exchange a small set of structured
postMessageevents. This is how the init token is delivered to the iframe and how the iframe reports back whether sign-in succeeded.
High-Level Architecture
When To Use Embedded vs. API-Only
| You want to… | Use |
|---|---|
| Show Tidely UI to your end users without rebuilding it | Embedded Integration (this guide) |
| Read or write financial data from your own backend / your own UI | Partner API |
| Both — embed Tidely and sync data via API | Combine both. They share the same partner credentials and accounts. |
Prerequisites
Before you can use the Embedded Integration you need:
- Partner OAuth 2.0 credentials — see Authentication. The same
client_id/client_secretthat you use for the Partner API are used to obtain init tokens. - A Tidely user that already exists in the customer account you want to embed. Init tokens log existing users in; they do not create users. User provisioning happens via the regular Partner API.
- A registered iframe origin. For security, Tidely only accepts
postMessagetraffic from origins that have been allow-listed for your partner. Send the origin(s) you intend to embed from to partnerships@tidely.com.
Base URLs
| Environment | Iframe src | Partner API base |
|---|---|---|
| Production | https://app.tidely.com/ | https://api.tidely.com/partner/v2 |
| Staging | https://app.sam.tidely.com/ | https://api.sam.tidely.com/partner/v2 |
Next Steps
→ Partner SSO — mint init tokens and exchange them for a logged-in session
→ Frontend Messaging — the postMessage protocol between parent and iframe