Iframe Integration Docs

depositOS is currently documented for iframe integration first.

For integrators, the setup is simple:

  • Host the iframe app at https://embed.deposit-os.com
  • Embed it in your product
  • Send config with postMessage
  • Listen for success/close/resize events

Important Notes

  • No API keys are required from end integrators in frontend integration.
  • The npm package is not publicly available yet, so docs currently focus on iframe usage instead of package install flows.
  • Use your configured API backend URL through the iframe host environment.

Recommended Path

Go directly to Iframe Embed for:

  • Parent page setup
  • postMessage protocol
  • Dynamic config updates
  • Security and origin validation
NextIframe Embed →