Method API Docs

Docs

• Attributes: Structured financial metrics for insights and recommendations.
• Portfolio Intelligence: Continuously monitor a borrower's liability profile after origination — balance trends, utilization shifts, and delinquency signals delivered via attributes and webhooks.
• Create Attributes
• List all Attributes
• The account attributes endpoint
• Retrieve Attributes
• Create a Balance
• List all Balances
• The balances endpoint
• Retrieve a Balance
• Create a Card Brand
• List all Card Brands
• The card brand endpoint
• Retrieve a Card Brand
• Withdraw an Account's Consent
• Create an Account
• List all Accounts
• The account endpoint
• Create Payment Instruments
• List Payment Instruments
• The payment instrument endpoint
• Retrieve Payment Instrument
• Create a Payoff
• List all Payoffs
• The payoffs endpoint
• Retrieve a Payoff
• List all Products
• The products endpoint
• Retrieve an Account
• Create a Sensitive
• List all Sensitives
• The sensitive endpoint
• Retrieve a Sensitive
• Create a Subscription
• Delete a Subscription
• List all Subscriptions
• The subscriptions endpoint
• Retrieve a Subscription
• List all Transactions
• The transactions endpoint
• Retrieve a Transaction
• Create an Update
• List all Updates
• The updates endpoint
• Retrieve an Update
• Create a Verification
• List all Verifications
• The account verification sessions endpoint
• Retrieve a Verification
• Update a Micro-deposits Verification
• Update an MX Verification
• Update a Network Verification
• Update a Plaid Verification
• Update a Pre-auth Verification
• Update a Standard Verification
• Update a Teller Verification
• Authentication
• The card product endpoint
• Retrieve a CardProduct
• The element endpoint
• Retrieve Element Results
• Create or Update Session
• Get Session
• The sessions endpoint
• Release Funds
• Create an Element Token
• Create Attributes
• List all Attributes
• The entity attributes endpoint
• Retrieve Attributes
• Create a Connect
• List all Connects
• The connect endpoint
• Retrieve a Connect
• Withdraw an Entity's Consent
• Create a Corporation
• Create an Individual
• Create Individual Credit Scores
• List all Credit Scores
• The credit score endpoint
• Retrieve Individual Credit Scores
• Create Identities
• List all Identities
• The identities endpoint
• Retrieve Identities
• List all Entities
• The entity endpoint
• List all Products
• The products endpoint
• Retrieve an Entity
• Create a Subscription
• Delete a Subscription
• List all Subscriptions
• The subscriptions endpoint
• Retrieve a Subscription
• Update an Entity
• Create Vehicles
• List all Vehicles
• The vehicles endpoint
• Retrieve Vehicles
• Create a BYO KYC Verification
• Create a BYO SMS Verification
• Create a KBA Verification
• Create an SMS Verification
• Create an SNA Verification
• List all Verification Sessions
• The entity verification sessions endpoint
• Retrieve a Verification Session
• Update a KBA Verification
• Update an SMS Verification
• Update an SNA Verification
• Environments
• Account Attribute Errors
• Account Errors
• Account Verification Session Errors
• Balance Errors
• Card Brand Errors
• Connect Errors
• Credit Score Errors
• Entity Attribute Errors
• Entity Errors
• Entity Verification Session Errors
• Forwarding Request Errors
• Identity Errors
• Payment Errors
• Payment Reversal Errors
• Payoff Errors
• Product Errors
• Request Errors
• Resource Errors
• Sensitive Errors
• Simulation Errors
• Subscription Errors
• Update Errors
• Vehicle Errors
• Webhook Errors
• List all Events
• The event endpoint
• Retrieve an Event
• Expanding Resources
• Create a Forwarding Request
• The Forwarding Request endpoint
• Retrieve a Forwarding Request
• Perform a Health Check
• Idempotency
• Introduction
• IP Whitelisting
• List all Managed Accounts
• List Managed Account Transactions
• The managed accounts endpoint
• Retrieve a Managed Account
• List all Merchants
• The merchant endpoint
• Retrieve a Merchant
• Message-Level-Encryption (MLE): End-to-end encryption for sensitive data transmission
• Metadata
• Create Token
• List Opal Events
• The Opal endpoint
• Pagination
• Create a Payment
• Delete a Payment
• List all Payments
• The payment endpoint
• Retrieve a Payment
• Rate Limiting
• Create a Report Schedule
• Delete a Report Schedule
• Add a Delivery Method
• Remove a Delivery Method
• Replace Delivery Methods
• List all Report Schedules
• The report schedules endpoint
• Add a Recipient
• Remove a Recipient
• Replace Recipients
• Retrieve a Report Schedule
• Add a Type
• Remove a Type
• Replace Types
• Update a Report Schedule
• Create a Report
• Download a Report
• The report endpoint
• Retrieve a Report
• Request IDs
• Create a Secret
• Delete a Secret
• List all Secrets
• The Secrets endpoint
• Retrieve a Secret
• Queue Attribute Behaviors
• Create a Card Brand
• Queue Connect Behaviors
• Create a Custom Credit Score
• Simulate an Event
• The simulate endpoint
• Update a Payment's Status
• Create a Transaction
• Retrieve Micro-deposit Amounts
• Create MLE Public Key
• Delete MLE Public Key
• List MLE Public Keys
• Get Method JWKS
• MLE Public Keys Overview: Manage your public keys for Message Level Encryption
• Retrieve MLE Public Key
• Retrieve Method Public Key
• Versioning
• Create a Webhook
• Delete a Webhook
• List all Webhooks
• The webhook endpoint
• Retrieve a Webhook
• Update a Webhook status
• December Updates
• November Updates
• October Updates
• September Updates
• April Updates
• August Updates
• December Updates
• February Updates
• January Updates
• July Updates
• June Updates
• March Updates
• May Updates
• November Updates
• October Updates
• September Updates
• April Updates
• February Updates
• January Updates
• March Updates
• May Updates
• Introducing API v2
• Introducing API Version 2025-07-04
• Introducing API Version 2025-12-01
• Introducing API Version 2026-03-30
• Create a Connect Element Token
• Getting Connect Results
• Launching a Connect Session
• Connect Overview
• Environments
• General Events
• Events Overview
• Element Specific Events
• Element SDKs
• Overview
• Handling Account Edge Cases: How to handle verification requirements, product limitations, and status changes.
• Funding Accounts: Setting up and verifying your corporate payment source.
• Supported Liability Types: The full range of consumer debt types Method supports.
• Account Lifecycle: Account statuses, available products, and state transitions.
• Accounts: Liability and funding accounts — the financial objects at the heart of your product.
• Card Brand: Card product names and visual card art for trust and engagement.
• Credit Scores: Credit score retrieval and monitoring for financial wellness products.
• Sensitive: Gated access to full account numbers and sensitive account data.
• Vehicles: Auto loan enrichment with VIN, make, model, and vehicle details.
• Core Concepts: The mental model for Method's platform — objects, relationships, and data flow.
• Errors and Edge Cases: Common Connect errors and how to handle them.
• How Connect Works: Soft-pull credit reports, auto vs manual discovery, and coverage.
• Connect — Account Discovery: How Method discovers your users' complete liability picture.
• Handling Partial Results: Designing for incomplete discovery results.
• Connect Subscriptions: Monitoring for new liabilities over time.
• Testing Connect: How to test Connect in development.
• Entity Errors — What Can Go Wrong and How to Handle It: What can go wrong during Entity creation and how to handle it.
• Entity Lifecycle — From Creation to Active Use: From creation to active use — understanding Entity states and transitions.
• Entities — The Foundation of Every Integration: What an Entity represents, why it matters, and how it maps to your users.
• IDV Errors & Edge Cases: Common verification errors, failure modes, and how to handle edge cases.
• Maximizing Verification Success: How to improve match rates and verification success through better data collection.
• Verification Methods: Choosing the right phone and identity verification approach for your integration.
• Verification Outcomes: Understanding the difference between Matched and Verified states.
• Identity Verification (IDV): Why identity verification matters and how the two-step process works.
• The Verification Flow: Step-by-step verification sequence, state transitions, webhooks, and code walkthroughs.
• Opal: Method's embedded UI for identity verification, account discovery, and more.
• What is Method: Method is the infrastructure layer for consumer liability data and payments.
• Payment Errors and Constraints: Processing windows, posting timing, return codes, and idempotency.
• Payment Instruments: Reusable payment configurations for recurring and repeated payments.
• Payment Lifecycle: What your users should see as payments move through the system.
• Payments: How Method moves money to pay down debt.
• Platform Fundamentals: Environments, authentication, data flow patterns, and webhooks.
• Quickstart: Get up and running with Method's four-step integration process.
• Billing Lifecycle and Data Availability: How a cardholder's billing stage determines which fields come back in an Update.
• Handling Update Failures: Recommended patterns for handling stale data and failed refreshes.
• Update Lifecycle: The stages of an Update request and how to track them.
• Updates: How Method keeps account data fresh, snapshot vs direct sources.
• Update Subscriptions: Set-and-forget monitoring to keep account data current.
• Card Linking & Checkout: Enrich connected cards with brand art, tokenize credentials for checkout, and build card-on-file experiences.
• Expense Tracking & Transactions: Stream real-time transactions, manage spend across credit cards, and handle manual card entry for unsupported networks.
• Getting Started: Create an entity, verify identity, and connect credit cards — the foundational 3-step flow for every commerce integration.
• Commerce: Build card linking, checkout, fraud prevention, and wallet experiences with Method's card connectivity and tokenization infrastructure.
• Application Pre-fill & Qualification: Pre-fill loan applications with verified liability data, pull real-time account details, and assess risk with credit health attributes.
• Debt Consolidation: Discover eligible accounts, verify current balances, and disburse funds directly to creditors.
• Getting Started: Create an entity, verify identity, and discover all liabilities for a loan applicant.
• Lending: Products that support the full lending lifecycle from application to repayment.
• Getting Started: The universal 3-step flow for PFM integrations: create an entity, verify identity, and connect liabilities.
• Debt Dashboard & Credit Insights: Build real-time debt dashboards with account updates, card brand art, credit scores, and financial health attributes.
• Onboarding & Liability Discovery: Identity verification options, liability discovery via Connect, ongoing connect subscriptions, and vehicle enrichment for auto loans.
• Digital Engagement & PFM: Build comprehensive personal financial management experiences with Method's liability data, credit insights, and payment infrastructure.
• Transactions & Bill Pay: Stream credit card transactions for spend management and initiate bill payments to your users' creditors.
• Overview
• Account Verification
• Card Connect
• Connect
• Opal Events
• Identity Verification
• Libraries
• Migration from Elements
• Overview: Method Opal - Next-generation embeddable financial components
• Quickstart: Get started with Method Opal in minutes
• Sessions: Maintain state and user data across Opal interactions.
• Transactions

OpenAPI Specs

• package-lock
• openapi