Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.methodfi.com/llms.txt

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

Method Opal is the single embeddable UI component that provides enhanced financial connectivity and user experience. Opal serves as a modern replacement for Method Elements, offering improved performance, better customization, and advanced features for integrating Method’s API into your application.

​
Authentication

All Opal endpoints require authentication using your Method API key. 
curl https://production.methodfi.com/opal/token \
  -H "Method-Version: 2025-12-01" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc"

​
Response:

{
  "success": true,
  "data": {
    "token": "otkn_THpBacqVBBrDkfqUf9htjm4QWAEJLY9a",
    "valid_until": "2025-05-08T22:21:40.312Z",
    "session_id": "osess_zde3mW34pEHqV"
  },
  "message": null
}
Refer to the Create Token section for more info on what properties can be passed in and how modes work.

​
Sessions

Sessions allow you to resume a user’s journey through Opal, while maintaining the user’s data and progress. Sessions are long-lived stateful connections that allows a user to leave and resume their journey through Opal while maintaining the user’s data and progress. Tokens are short-lived identifiers that initialize the Opal flow. See Opal Sessions for more information.

​
Environments

Opal can be launched from all Method environments:
EnvironmentOpal URL
Developmenthttps://opal.dev.methodfi.com
Sandboxhttps://opal.sandbox.methodfi.com
Productionhttps://opal.production.methodfi.com
Or, launch Opal from your app using one of our libraries.