How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MethodFi Opal API

Opal client-side session and token management

MethodFi Opal API is one of 44 APIs that MethodFi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Opal. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 1 path, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 2025-12-01.

Requests are made against 3 base URLs: https://production.methodfi.com, https://sandbox.methodfi.com, https://dev.methodfi.com.

3 operations 1 paths 12 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2025-12-01
Base URL
https://production.methodfi.com
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

MethodFi Opal API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpalToken). It accepts HTTP bearer tokens (SecretKey). By default, every request must be authenticated.

  • OpalToken — Opal token authentication for Opal session endpoints. Use an Opal token (otkn...) as the Bearer token. Created via POST /opal/token using a secret key.
  • SecretKey — Secret key authentication. Use your team's secret key (sk...) as the Bearer token. All authenticated API endpoints require this scheme unless otherwise noted.

Paths & Operations 3

Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Opal 3

Opal client-side session and token management

GET
/opal/token
Retrieve an Opal session
retrieveOpalToken 1 param → 200400401429500
POST
/opal/token
Create an Opal token
createOpalToken 1 param body → 200400401422429500
DELETE
/opal/token
Deactivate an Opal token
deactivateOpalToken 1 param → 200400401429500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are OpalSession (11 properties), OpalTokenCreateRequest (10 properties), ErrorObject (4 properties), ErrorEnvelope (3 properties). Each schema is shown below with its type and property counts.

SuccessEnvelope
object
Standard envelope for successful responses that return a single payload.
3 properties 3 required
OpalToken
object
A short-lived token used to authenticate an Opal session from a client application.
3 properties 3 required
ErrorEnvelope
object
3 properties 3 required
OpalNullResponse
OpalConnectAccountFilters
object
Account filters for the connect mode.
2 properties
OpalSession
object
An Opal session representing a client-side workflow for identity verification, account connection, or account verification.
11 properties 11 required
OpalSessionResponse
OpalSessionMode
string
The mode that determines which flows are configured for the session.
OpalTokenResponse
OpalTokenCreateRequest
object
Request to create an Opal token. Supports three creation patterns: (A) existing entity via entityid, (B) inline entity via entity, or (C) existing session via…
10 properties
OpalCardConnectAccountFilters
object
Account filters for the cardconnect mode.
1 property
ErrorObject
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

methodfi-opal-api-openapi.yml Raw ↑

Other APIs MethodFi publishes across the network.

MethodFi Account Attributes API
MethodFi Account Balances API
MethodFi Account Card Brands API
MethodFi Account Consent API
MethodFi Account Payment Instruments API
MethodFi Account Payoffs API
MethodFi Account Products API
MethodFi Account Sensitive API
MethodFi Account Subscriptions API
MethodFi Account Transactions API
MethodFi Account Updates API
MethodFi Account Verification Sessions API
Where this information came from

This is an independent, third-party profile of MethodFi Opal API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.