### Method API Reference - Get Started Source: https://docs.methodfi.com/reference/accounts/updates/create Provides a link to the 'Get Started' page for new users of the Method API. This typically includes setup instructions and initial configuration. ```APIDOC Endpoint: /get-started Method: GET Description: Redirects to the Method API Get Started page. Parameters: None Returns: 302 Found (Redirect to https://methodfi.com/contact-us) ``` -------------------------------- ### Method API: Introduction Source: https://docs.methodfi.com/reference/authentication Learn how to get started with Method's API. This section provides an overview of the API's capabilities and initial setup steps. ```APIDOC /reference/introduction - Overview of the Method API. - Key features and use cases. - Getting started guide. ``` -------------------------------- ### API Reference Introduction Source: https://docs.methodfi.com/changelog/api-versions/2024-04-04 Provides an overview and getting started guide for the MethodFi API. Covers essential concepts for API integration. ```APIDOC API Reference: Introduction - Overview of MethodFi API - Getting started guide - Key concepts for integration ``` -------------------------------- ### Method API Introduction Source: https://docs.methodfi.com/reference/events/overview Learn how to get started with Method's API. This section covers the initial steps and overview of the API. ```APIDOC Introduction: Overview of Method's API. Covers getting started. Related: Authentication, Environments ``` -------------------------------- ### Method API Introduction Source: https://docs.methodfi.com/reference/accounts/verification-sessions/update-network Get started with Method's API. This section covers the initial steps and overview of the API's capabilities. ```APIDOC GET /reference/introduction Description: Learn how to get started with Method's API. Twitter Image: https://static.methodfi.com/assets/api-docs-og.png Twitter Description: Learn how to get started with Method's API. ``` -------------------------------- ### Method API Introduction Source: https://docs.methodfi.com/reference/accounts/verification-sessions/update-preauth Get started with Method's API. This section covers the initial steps and overview of the API's capabilities. ```APIDOC GET /reference/introduction Description: Learn how to get started with Method's API. Twitter Image: https://static.methodfi.com/assets/api-docs-og.png Twitter Description: Learn how to get started with Method's API. ``` -------------------------------- ### Method API Reference Overview Source: https://docs.methodfi.com/reference/entities/verification-sessions/overview Provides an overview of the Method API, including getting started, authentication, environments, idempotency, expanding resources, request IDs, versioning, pagination, and metadata. ```APIDOC API Reference: - Introduction: Learn how to get started with Method's API. - Authentication: Details on authenticating API requests. - Environments: Information on different API environments. - Idempotency: Explanation of idempotency for safe retries. - Expanding Resources: How to expand related resources in responses. - Request IDs: Understanding and using request identifiers. - Versioning: API versioning strategy. - Pagination: How to paginate through results. - Metadata: Information on response metadata. ``` -------------------------------- ### Mintlify Documentation Configuration Source: https://docs.methodfi.com/reference/elements/results Configuration object for Mintlify, defining schema, theme, name, colors, favicon, and navigation structure. This setup guides the generation and appearance of the documentation site. ```json { "$schema": "https://mintlify.com/docs.json", "theme": "mint", "name": "Method API Docs", "colors": { "primary": "#00B29D", "light": "#00B29D", "dark": "#00B29D" }, "favicon": "/icons/opal-fill-logo.png", "navigation": { "tabs": [ { "tab": "API Reference", "groups": [ { "group": "API Reference", "pages": [ "reference/introduction", "reference/authentication", "reference/environments", "reference/idempotency", "reference/expanding", "reference/request-id", "reference/versioning", "reference/pagination", "reference/metadata" ] } ] } ] } } ``` -------------------------------- ### API Reference - Introduction Source: https://docs.methodfi.com/reference/accounts/subscriptions/list Provides an overview of the Method API, including its purpose and how to get started with API integration. ```APIDOC reference/introduction ``` -------------------------------- ### Method API Reference Introduction Source: https://docs.methodfi.com/changelog/api-versions/2024-04-04 Provides an overview of the Method API, its purpose, and how to get started. It outlines the core concepts and structure of the API. ```APIDOC reference/introduction - Overview of the Method API - Core concepts and structure ``` -------------------------------- ### Method API Reference Introduction Source: https://docs.methodfi.com/elements/libraries Provides an overview of the Method API, covering core concepts, available resources, and how to get started with integrating financial data and services. ```APIDOC API Reference: introduction authentication environments idempotency expanding request-id versioning pagination metadata ``` -------------------------------- ### List Verification Sessions Examples Source: https://docs.methodfi.com/reference/entities/verification-sessions/list Examples demonstrating how to list verification sessions using cURL and the Methodfi Python SDK. ```shellscript curl "https://production.methodfi.com/entities/ent_yVf3mkzbhz9tj/verification_sessions" \ -H "Method-Version: 2024-04-04" \ -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" ``` ```python response = method.entities('ent_yVf3mkzbhz9tj').verification_sessions.list() ``` -------------------------------- ### Python Example: List Verifications Source: https://docs.methodfi.com/reference/accounts/verification-sessions/list Example of how to list verification sessions using the MethodFi Python SDK. ```python response = method.accounts('acc_yVf3mkzbhz9tj').verification_sessions.list() ``` -------------------------------- ### Python Example for Listing Account Updates Source: https://docs.methodfi.com/reference/accounts/updates/list Example demonstrating how to use the MethodFi Python SDK to list account updates. ```python response = method.accounts('acc_yVf3mkzbhz9tj') ``` -------------------------------- ### Python SDK Example Source: https://docs.methodfi.com/reference/accounts/balances/list Example of how to call the List all Balances API using the Method Python SDK. ```python response = method .accounts('acc_yVf3mkzbhz9tj') .balances .list() ``` -------------------------------- ### Method API Reference - Introduction Source: https://docs.methodfi.com/reference/errors/payoff-errors Provides an overview and getting started guide for the Method API. Includes information on how to begin integrating with Method's financial services. ```APIDOC API Reference: Introduction - Provides an overview and getting started guide for the Method API. - href: /reference/introduction ``` -------------------------------- ### Method API Introduction and Core Concepts Source: https://docs.methodfi.com/reference/accounts/transactions/overview Guides users through getting started with the Method API, covering essential concepts like authentication, environments, idempotency, expanding resources, request IDs, versioning, pagination, and metadata. ```APIDOC Introduction: Learn how to get started with Method's API. href: /reference/introduction Authentication: Details on how to authenticate your API requests. href: /reference/authentication Environments: Information about different API environments. href: /reference/environments Idempotency: Explanation of idempotency in API requests. href: /reference/idempotency Expanding Resources: How to expand related resources in your API calls. href: /reference/expanding Request IDs: Understanding and using request IDs. href: /reference/request-id Versioning: Information on API versioning. href: /reference/versioning Pagination: How to paginate through API results. href: /reference/pagination Metadata: Details on metadata associated with API resources. href: /reference/metadata ``` -------------------------------- ### Connect - Overview and Token Creation Source: https://docs.methodfi.com/elements/events/overview Guides for using MethodFi Connect, including an overview, creating connect tokens, and launching the connect flow. ```APIDOC elements/connect/overview elements/connect/create_connect_token elements/connect/launch_connect ``` -------------------------------- ### Get Payments Example Source: https://docs.methodfi.com/reference/versioning Example cURL command to fetch payments from the MethodFi API. It includes pagination and date filtering parameters, along with necessary authentication headers. ```curl curl "https://production.methodfi.com/payments?page_limit=1&to_date=2020-12-10" \ -H "Method-Version: 2024-04-04" \ -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" ``` -------------------------------- ### JavaScript Server Listen Example Source: https://docs.methodfi.com/reference/webhooks/overview Example of a JavaScript server listening on a specific port and logging a confirmation message. This snippet demonstrates basic server setup. ```javascript app.listen(3000, () => console.log('Listening on port 3000')); ``` -------------------------------- ### JavaScript Configuration Example Source: https://docs.methodfi.com/libraries/js-sdk Creates an instance of the Method class after the initialization script is included. This example shows basic configuration options like environment and event handling. ```javascript const config = { env: 'production', // dev | sandbox | production onEvent: ``` -------------------------------- ### Elements - Connect Documentation Source: https://docs.methodfi.com/reference/accounts/products/overview Guides for using MethodFi Connect, including token creation and launching the connection flow. ```APIDOC Elements Connect: Overview: elements/connect/overview Create Connect Token: elements/connect/create_connect_token Launch Connect: elements/connect/launch_connect Get Results: elements/connect/get_results ``` -------------------------------- ### MethodFi Python API Interaction Example Source: https://docs.methodfi.com/libraries/js-sdk A placeholder for Python code interacting with MethodFi APIs. This snippet is incomplete but suggests a setup for API calls, potentially related to the JavaScript token creation example. ```python # Placeholder for Python code interacting with MethodFi APIs. # This might involve setting up API clients or making requests. # Example: # from methodfi import MethodClient # client = MethodClient(api_key="YOUR_API_KEY") # ... further operations ... ``` -------------------------------- ### Method API - JavaScript Client Example Source: https://docs.methodfi.com/reference/accounts/verification-sessions/list Example of how to use the Method API client in JavaScript to list verification sessions. This demonstrates making a GET request to the verification sessions endpoint. ```javascript import Method from '@methodfi/method-node'; const method = new Method('YOUR_API_KEY'); async function listVerificationSessions() { try { const verificationSessions = await method.verificationSessions.list({ limit: 10, status: 'succeeded' }); console.log('Succeeded Verification Sessions:', verificationSessions.data); return verificationSessions; } catch (error) { console.error('Error listing verification sessions:', error); throw error; } } // Example usage: // listVerificationSessions(); ``` -------------------------------- ### HTML Installation Script Source: https://docs.methodfi.com/libraries/js-sdk Includes the Method initialization script into your application’s main HTML file. This script is essential for enabling Method Elements functionality. ```html ``` -------------------------------- ### Footer Navigation Structure - Popular Guides (JavaScript) Source: https://www.moderntreasury.com/ach-return-codes/r14 This JavaScript snippet details the structure for popular guides and resources in a footer. It includes internal links to tools like the 'ACH Return Code Tool' and articles on bank partnerships and account setup. ```javascript self.__next_f.push([ 1, "2d:[\"$\",\"div\",null,{\"className\":\"link-grid secondary\",\"children\":[[\"$\",\"div\",\"0\",{\"className\":\"link-group columns--2\",\"children\":[[\"$\",\"div\",null,{\"className\":\"link-group-label\",\"children\":\"Popular Guides\"}],[\"$\",\"div\",null,{\"className\":\"link-group-links\",\"children\":[[\"$\",\"$L21\",\"0\",{\"clickableType\":\"internal\",\"href\":\"/ach-return-codes\",\"text\":\"ACH Return Code Tool\",\"className\":\"text-body-md text-color-dim-text hover:text-color-default-text\",\"customEventData\":{\"origin_ui\":\"Footer\"}}],[\"$\",\"$L21\",\"1\",{\"clickableType\":\"internal\",\"href\":\"/journal/which-bank-partner-is-best-for-you\",\"text\":\"Which Bank Partner is Best for You?\",\"className\":\"text-body-md text-color-dim-text hover:text-color-default-text\",\"customEventData\":{\"origin_ui\":\"Footer\"}}],[\"$\",\"$L21\",\"2\",{\"clickableType\":\"internal\",\"href\":\"/journal/when-and-how-to-get-an-fbo-account\" ``` -------------------------------- ### Elements - Connect Documentation Source: https://docs.methodfi.com/reference/entities/products/overview Guides for using MethodFi Connect, including token creation and launching the connection flow. ```APIDOC Elements Connect: Overview: elements/connect/overview Create Connect Token: elements/connect/create_connect_token Launch Connect: elements/connect/launch_connect Get Results: elements/connect/get_results ``` -------------------------------- ### Popular Guides & Resources Source: https://www.moderntreasury.com/ach-return-codes/r14 This section lists popular guides and resources, including tools and articles designed to help users understand specific financial processes or best practices. Examples include an ACH Return Code Tool and articles on bank partnerships. ```APIDOC Popular Guides: - ACH Return Code Tool: /ach-return-codes - Which Bank Partner is Best for You?: /journal/which-bank-partner-is-best-for-you - When and How to Get an FBO Account: /journal/when-and-how-to-get-an-fbo-account ``` -------------------------------- ### MethodFi API Reference Overview Source: https://docs.methodfi.com/elements/events/overview Provides an overview of the MethodFi API, including general concepts and how to get started. ```APIDOC API Reference: Introduction: Learn how to get started with Method's API. Authentication: Details on authenticating API requests. Environments: Information about different API environments. Idempotency: Explanation of idempotency for safe API operations. Expanding Resources: How to expand related resources in API responses. Request IDs: Understanding and using request IDs for tracking. Versioning: Information on API versioning strategies. Pagination: How to paginate through API results. Metadata: Details on metadata associated with API resources. ``` -------------------------------- ### Initialize MethodFi Python and List Accounts Source: https://docs.methodfi.com/reference/authentication Shows how to import and initialize the MethodFi Python client with an API key and environment, followed by listing available accounts. ```python from method import Method method = Method(env='production', api_key='sk_WyZEWVfTcH7GqmPzUPk65Vjc') accounts = method.accounts.list() ``` -------------------------------- ### Methodfi API v2 Introduction Source: https://docs.methodfi.com/reference/environments Announcement for the launch of API v2, the second major version of the Method API. This entry includes descriptive metadata and a link to the relevant changelog page. ```json { "title": "Introducing API v2", "sidebarTitle": "2024-04-04", "og:image": "https://s3.us-west-2.amazonaws.com/static.methodfi.tldn/assets/docs-release-v2-2024-04-04-og.png", "og:description": "We are excited to announce the launch of API v2 - the highly anticipated second version of Method's API!", "twitter:image": "https://s3.us-west-2.amazonaws.com/static.methodfi.tldn/assets/docs-release-v2-2024-04-04-og.png", "twitter:description": "We are excited to announce the launch of API v2 - the highly anticipated second version of Method's API!", "description": null, "href": "/changelog/api-versions/2024-04-04" } ``` -------------------------------- ### Elements - Core Functionality Source: https://docs.methodfi.com/reference/accounts/subscriptions/overview Guides for using Method Elements, covering an overview, environment setup, and integration with client-side libraries. ```APIDOC elements/overview elements/environments elements/libraries ``` -------------------------------- ### Initialize Methodfi and List Accounts in Python Source: https://docs.methodfi.com/reference/authentication Shows how to import and initialize the Methodfi library in Python, setting the environment and API key. It then demonstrates calling the `accounts.list()` method to retrieve account information. ```python from method import Method method = Method(env="production", api_key="sk_WyZEWVfTcH7GqmPzUPk65Vjc") accounts = method.accounts.list() ``` -------------------------------- ### API Reference - Introduction and Core Concepts Source: https://docs.methodfi.com/reference/entities/verification-sessions/create-byo-kyc Provides foundational information for using the Method API, including guides on authentication, environments, idempotency, request IDs, versioning, pagination, and metadata. Essential for understanding how to interact with the API. ```APIDOC reference/introduction reference/authentication reference/environments reference/idempotency reference/expanding reference/request-id reference/versioning reference/pagination reference/metadata ``` -------------------------------- ### Methodfi API Reference - Introduction and Core Concepts Source: https://docs.methodfi.com/reference/environments Provides an overview of the Methodfi API, including essential concepts like authentication, environments, idempotency, expanding resources, request IDs, versioning, pagination, metadata, and error handling. ```APIDOC API Reference: Introduction Authentication Environments Idempotency Expanding Resources Request IDs Versioning Pagination Metadata Errors ``` -------------------------------- ### JavaScript Error Handling Example Source: https://docs.methodfi.com/reference/accounts/products/overview A common JavaScript error message thrown when a component or object is expected but not found. It guides the developer to check imports or provided values. ```javascript throw new Error("Expected \"" + (component ? \"component\" : \"object\") + \" `\" + id + `\" to be defined: you likely forgot to import, pass, or provide it."); ``` -------------------------------- ### Connect Integration Source: https://docs.methodfi.com/reference/accounts/sensitive/create Guides for integrating with MethodFi Connect, including token creation and launching the connection flow. ```APIDOC Connect Integration: Overview: elements/connect/overview Create Connect Token: elements/connect/create_connect_token Launch Connect: elements/connect/launch_connect Get Results: elements/connect/get_results ``` -------------------------------- ### Method API Introduction and Authentication Source: https://docs.methodfi.com/reference/accounts/card-brands/overview Provides an overview of the Method API, including essential information on authentication methods, API keys, and how to get started with API requests. ```APIDOC API Reference: Introduction: Overview: Provides an overview of the Method API. Authentication: Overview: Details on how to authenticate your API requests using API keys. API Key Usage: Include your API key in the Authorization header as a Bearer token. Example: Authorization: Bearer YOUR_API_KEY ``` -------------------------------- ### Curl Example for Creating a Subscription Source: https://docs.methodfi.com/reference/accounts/subscriptions/create A practical example using curl to demonstrate how to make a POST request to create a subscription, including necessary headers and the endpoint URL. ```shellscript curl https://production.methodfi.com/accounts/acc_yVf3mkzbhz9tj/subscriptions \ -X POST \ -H "Method-Version: 2024-04-04" \ -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" ``` -------------------------------- ### Method API Reference - Environments Source: https://docs.methodfi.com/reference/accounts/verification-sessions/list Explains the different environments available for the Method API (e.g., sandbox, production) and how to use them. ```APIDOC reference/environments ``` -------------------------------- ### Connect Token and Launch Connect Source: https://docs.methodfi.com/reference/entities/verification-sessions/create-byo-kyc References for obtaining connection tokens and launching the connect flow, likely for integrating external services. ```APIDOC elements/connect/token elements/connect/launch_connect elements/connect/get_results ``` -------------------------------- ### Create Account Instance Source: https://docs.methodfi.com/reference/authentication Shows how to create an instance for managing accounts using the MethodFI LLM client. This is typically used after initializing the main client. ```javascript const accounts = new Method({ apiKey: 'sk_WyZEWVfTcH7GqmPzUPk65Vjc', env: Environments.production, }); ``` -------------------------------- ### Initialize MethodFI LLM Client Source: https://docs.methodfi.com/reference/authentication Demonstrates how to import and initialize the MethodFI LLM client with an API key and environment configuration. This is the first step to interact with the LLM services. ```javascript const { Method } = require('method-node'); const method = new Method({ apiKey: 'sk_WyZEWVfTcH7GqmPzUPk65Vjc', env: Environments.production, }); ``` -------------------------------- ### List Card Brands using cURL Source: https://docs.methodfi.com/reference/accounts/card-brands/list Example of how to list card brands using cURL. This command makes a GET request to the API endpoint, including the necessary Authorization header with a Bearer token. ```Bash curl -X GET https://production.methodfi.com/accounts/acc_yVf3mkzbhz9tj/card_brands \ -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" ``` -------------------------------- ### Elements Overview and Libraries Source: https://docs.methodfi.com/reference/entities/verification-sessions/create-kba Documentation for the Elements product, covering its overview and available libraries. ```APIDOC elements/overview elements/environments elements/libraries ``` -------------------------------- ### Mintlify Documentation Configuration Source: https://docs.methodfi.com/reference/authentication Configuration object for Mintlify, specifying the documentation schema, theme, site name, color scheme, favicon, and navigation layout. This setup guides the rendering and structure of the API reference. ```APIDOC docsConfig: $schema: "https://mintlify.com/docs.json" theme: "mint" name: "Method API Docs" colors: primary: "#00B29D" light: "#00B29D" dark: "#00B29D" favicon: "/icons/opal-fill-logo.png" navigation: tabs: - tab: "API Reference" groups: - group: "API Reference" pages: - "reference/introduction" - "reference/authentication" - "reference/environments" - "reference/idempotency" - "reference/expanding" - "reference/request-id" - "reference/versioning" - "reference/pagination" - "reference/metadata" - group: "Errors" pages: - "reference/errors/request-errors" - "reference/errors/resource-errors" - group: "Entities" pages: - "reference/errors/entity-errors" - "reference/errors/entity-verification-session-errors" - "reference/errors/identity-errors" - "reference/errors/connect-errors" - "reference/errors/credit-score-errors" - "reference/errors ``` -------------------------------- ### API Reference Overview Source: https://docs.methodfi.com/reference/entities/verification-sessions/create-byo-kyc General API reference documentation covering introduction, authentication, environments, idempotency, resource expansion, request IDs, versioning, pagination, and error handling. ```APIDOC /reference/introduction Description: Introduction to the Methodfi API. /reference/authentication Description: Details on how to authenticate API requests. /reference/environments Description: Information about different API environments. /reference/idempotency Description: Explanation of idempotency keys for safe retries. /reference/expanding Description: How to expand resources to include related data. /reference/request-id Description: Information on request IDs for tracing. /reference/versioning Description: Details on API versioning strategy. /reference/pagination Description: How to paginate through lists of resources. /reference/metadata Description: Information about metadata in API responses. Errors Description: Documentation on API error codes and formats. ``` -------------------------------- ### Method API Reference - Introduction and Core Concepts Source: https://docs.methodfi.com/reference/errors/payment-errors Covers fundamental aspects of the Method API, including getting started, authentication mechanisms, environment details, idempotency, request IDs, versioning, and pagination strategies. ```APIDOC API Reference: Introduction: - Overview of the Method API and its capabilities. Authentication: - Details on how to authenticate API requests. Environments: - Information on different API environments (e.g., sandbox, production). Idempotency: - Explanation of idempotency keys for safe request retries. Expanding: - How to expand related resources in API responses. Request ID: - Understanding and using request IDs for tracing. Versioning: - API versioning strategy and how to specify versions. Pagination: - Methods for paginating through lists of resources. ``` -------------------------------- ### Method API Configuration and Navigation Source: https://docs.methodfi.com/reference/entities/verification-sessions/create-kba Configuration details for the Method API documentation site, including base URL, playground settings, color schemes, top bar calls to action, and a comprehensive navigation structure covering various API reference topics, error types, and entities. ```APIDOC MintConfig: schema: https://mintlify.com/schema.json name: Method API Docs logo: $11:props:docsConfig:logo favicon: /icons/opal-fill-logo.png api: baseUrl: https://production.methodfi.com playground: mode: simple modeToggle: default: dark colors: primary: "#00B29D" light: "#00B29D" dark: "#00B29D" background: dark: "#030A26" anchors: from: "#FF7F57" to: "#127575" topbarCtaButton: name: "Sign In" url: "https://dashboard.methodfi.com/login" topbarLinks: - url: "https://methodfi.com/contact-us" name: "Get Started" _id: "6880f704d9264c185f514bad" navigation: - group: "API Reference" pages: - "reference/introduction" - "reference/authentication" - "reference/environments" - "reference/idempotency" - "reference/expanding" - "reference/request-id" - "reference/versioning" - "reference/pagination" - "reference/metadata" - group: "Errors" pages: - "reference/errors/request-errors" - "reference/errors/resource-errors" - group: "Entities" pages: - "reference/errors/entity-errors" - "reference/errors/entity-verification-session-errors" - "reference/errors/identity-errors" - "reference/errors/connect-errors" - "reference/errors/credit-score-errors" - "reference/errors/vehicle-errors" - "reference/errors/entity-attribute-errors" - group: "Accounts" pages: - "reference/errors/account-errors" - "reference/errors/account-verification-session-errors" - "reference/errors/balance-errors" - "reference/errors/card-brand-errors" - "reference/errors/update-errors" - "reference/errors/payoff-errors" - "reference/errors/sensitive-errors" - "reference/errors/account-attribute-errors" - group: "Payments" pages: - "reference/errors/payment-errors" - "reference/errors/payment-reversal-errors" - "reference/errors/product-errors" ``` -------------------------------- ### Initialize MethodFi JS and List Accounts Source: https://docs.methodfi.com/reference/authentication Demonstrates how to initialize the MethodFi JavaScript client with an API key and environment, and subsequently fetch a list of accounts. ```javascript const method = new Method({ apiKey: 'sk_WyZEWVfTcH7GqmPzUPk65Vjc', env: Environments.production }); const accounts = method.accounts.list(); ``` -------------------------------- ### MethodFi API Reference Overview Source: https://docs.methodfi.com/reference/errors/webhook-errors This section covers fundamental aspects of interacting with the MethodFi API, including getting started, authentication mechanisms, managing environments, ensuring idempotency, handling request IDs, versioning strategies, pagination for large datasets, and metadata usage. It also details common error types and specific error codes for various resources. ```APIDOC Introduction: Description: Learn how to get started with Method's API. Authentication: Description: Details on how to authenticate your API requests. Environments: Description: Information about different API environments. Idempotency: Description: How to ensure API requests are idempotent. Expanding Resources: Description: How to expand related resources in API responses. Request IDs: Description: Understanding and using request IDs. Versioning: Description: API versioning policies. Pagination: Description: How to paginate through API results. Metadata: Description: Information on using metadata with API requests. Request Errors: Description: Common errors related to API requests. Resource Errors: Description: Errors specific to API resources. Entity Errors: Description: Errors related to entity operations. Entity Verification Session Errors: Description: Errors for entity verification sessions. Identity Errors: Description: Errors related to identity management. Connect Errors: Description: Errors associated with the Connect feature. Credit Score Errors: Description: Errors pertaining to credit score data. Vehicle Errors: Description: Errors related to vehicle data. Entity Attribute Errors: Description: Errors for entity attribute operations. Account Errors: Description: Errors related to account management. Account Verification Session Errors: Description: Errors for account verification sessions. Balance Errors: Description: Errors concerning account balances. Card Brand Errors: Description: Errors related to card brand information. Update Errors: Description: Errors encountered during update operations. Payoff Errors: Description: Errors related to payoff calculations. Sensitive Errors: Description: Errors for sensitive data operations. Account Attribute Errors: Description: Errors for account attribute operations. Payment Errors: Description: Errors related to payment processing. Payment Reversal Errors: Description: Errors encountered during payment reversals. Product Errors: Description: Errors related to product management. Subscription Errors: Description: Errors concerning subscription management. Webhook Errors: Description: Errors related to webhook delivery and processing. ``` -------------------------------- ### Install react-method-elements Source: https://github.com/MethodFi/react-method-elements Installs the react-method-elements package as a dependency for your project using npm. ```bash npm install --save react-method-elements ``` -------------------------------- ### Mintlify Documentation Configuration Source: https://docs.methodfi.com/reference/entities/verification-sessions/create-kba Defines the configuration object for the Mintlify documentation site. It specifies the theme, site name, primary colors, favicon, and the detailed navigation structure with grouped pages for API references, authentication, errors, and entities. ```APIDOC docsConfig: $schema: "https://mintlify.com/docs.json" theme: "mint" name: "Method API Docs" colors: primary: "#00B29D" light: "#00B29D" dark: "#00B29D" favicon: "/icons/opal-fill-logo.png" navigation: tabs: - tab: "API Reference" groups: - group: "API Reference" pages: - "reference/introduction" - "reference/authentication" - "reference/environments" - "reference/idempotency" - "reference/expanding" - "reference/request-id" - "reference/versioning" - "reference/pagination" - "reference/metadata" - group: "Errors" pages: - "reference/errors/request-errors" - "reference/errors/resource-errors" - group: "Entities" pages: - "reference/errors/entity-errors" - "reference/errors/entity-verification-session-errors" - "reference/errors/identity-errors" - "reference/errors/connect-errors" - "reference/errors/credit-score-errors" - "reference/errors/vehicle-errors" - "reference/errors/entity-attribute-errors" - group: "Accounts" pages: - "reference/errors/account-errors" - "reference/errors/account-verification-session-errors" - "reference/errors/balance-errors" - "reference/errors/card-brand-errors" - "reference/errors/update-errors" - "reference/errors/payoff-errors" - "reference/errors/sensitive-errors" - "reference/errors/account-attribute-errors" - group: "Payments" pages: - "reference/errors/payment-errors" - "reference/errors/payment-reversal-errors" - "reference/errors/product-errors" - "reference/errors/subscription-errors" - "reference/errors/webhook-errors" ``` -------------------------------- ### Elements - Overview and Environments API Endpoints Source: https://docs.methodfi.com/reference/entities/verification-sessions/create-kba Provides general overview information for Elements and details about managing different environments and libraries. ```APIDOC Elements - General: - GET /elements/overview - GET /elements/environments - GET /elements/libraries ``` -------------------------------- ### Sensitive Endpoint API Examples Source: https://docs.methodfi.com/reference/accounts/sensitive/overview API documentation and examples for the sensitive endpoint, demonstrating how to interact with data for different financial instruments. Each example shows a specific request payload structure. ```APIDOC Credit Card: Request Payload: { "type": "credit_card", "account_number": "1234567890123456", "cardholder_name": "John Doe", "expiration_date": "12/25", "cvv": "123" } Description: Example payload for a credit card transaction or data submission. ``` ```APIDOC Auto Loan: Request Payload: { "type": "auto_loan", "loan_id": "AL7890", "borrower_name": "Jane Smith", "loan_amount": 25000.50, "interest_rate": 4.5 } Description: Example payload for an auto loan record. ``` ```APIDOC Mortgage: Request Payload: { "type": "mortgage", "mortgage_id": "MG1122", "property_address": "123 Main St", "borrower_name": "Peter Jones", "loan_amount": 300000.00, "interest_rate": 3.75 } Description: Example payload for a mortgage account. ``` ```APIDOC Personal Loan: Request Payload: { "type": "personal_loan", "loan_id": "PL3456", "borrower_name": "Alice Williams", "loan_amount": 10000.00, "purpose": "Debt Consolidation" } Description: Example payload for a personal loan. ``` ```APIDOC Collection: Request Payload: { "type": "collection", "collection_id": "CL6789", "debtor_name": "Robert Brown", "original_creditor": "Bank XYZ", "amount_due": 5000.75 } Description: Example payload for a collection account. ``` -------------------------------- ### Mintlify Documentation Configuration Source: https://docs.methodfi.com/reference/entities/subscriptions/create Configuration settings for Mintlify, specifying the documentation schema, theme, project name, primary colors, favicon, and navigation structure. ```json { "$schema": "https://mintlify.com/docs.json", "theme": "mint", "name": "Method API Docs", "colors": { "primary": "#00B29D", "light": "#00B29D", "dark": "#00B29D" }, "favicon": "/icons/opal-fill-logo.png", "navigation": { "tabs": [ { "tab": "API Reference", "groups": [ { "group": "API Reference", "pages": [ "reference/introduction", "reference/authentication", "reference/environments", "reference/idempotency", "reference/expanding", "reference/request-id", "reference/versioning", "reference/pagination", "reference/metadata" ] }, { "group": "Errors", "pages": [ "reference/errors/request-errors", "reference/errors/resource-errors", { "group": "Entities", "pages": [ "reference/errors/entity-errors", "reference/errors/entity-verification-session-errors", "reference/errors/identity-errors", "reference/errors/connect-errors", "reference/errors/credit-score-errors", "reference/errors/vehicle-errors", "reference/errors/entity-attribute-errors" ] }, { "group": "Accounts", "pages": [ "reference/errors/account-errors" ] } ] } ] } ] } } ``` -------------------------------- ### List Identities for Entity (Examples) Source: https://docs.methodfi.com/reference/entities/identities/list Provides code examples for listing identities for a specific entity using cURL, Node.js, and Python. These examples demonstrate how to authenticate and make the API request. ```cURL curl "https://production.methodfi.com/entities/ent_yVf3mkzbhz9tj/identities" \ -H "Method-Version: 2024-04-04" \ -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" ``` ```Node.js // Node.js example would go here, typically using a library like 'axios' or 'node-fetch' // Example structure: /* const axios = require('axios'); async function listIdentities(entityId, apiKey) { const url = `https://production.methodfi.com/entities/${entityId}/identities`; try { const response = await axios.get(url, { headers: { 'Method-Version': '2024-04-04', 'Authorization': `Bearer ${apiKey}` } }); return response.data; } catch (error) { console.error('Error fetching identities:', error); throw error; } } */ ``` ```Python # Python example would go here, typically using the 'requests' library # Example structure: /* import requests def list_identities(entity_id, api_key): url = f"https://production.methodfi.com/entities/{entity_id}/identities" headers = { "Method-Version": "2024-04-04", "Authorization": f"Bearer {api_key}" } try: response = requests.get(url, headers=headers) response.raise_for_status() # Raise an exception for bad status codes return response.json() except requests.exceptions.RequestException as e: print(f"Error fetching identities: {e}") return None */ ``` -------------------------------- ### Connect API Reference Source: https://docs.methodfi.com/reference/entities/verification-sessions/create-byo-kyc Documentation for MethodFi Connect, covering token creation, launching Connect, and retrieving results. ```APIDOC Connect: Overview: elements/connect/overview Create Connect Token: elements/connect/create_connect_token Launch Connect: elements/connect/launch_connect Get Results: elements/connect/get_results ``` -------------------------------- ### Payment Instrument Request Examples Source: https://docs.methodfi.com/reference/accounts/payment-instruments/overview Provides example requests for creating payment instruments, specifically for card and network token types. These examples illustrate the structure and data required for successful API interactions. ```APIDOC Card Payment PaymentInstrument: // Example structure for a card payment instrument // Parameters and fields would be detailed here. // Example: { // "type": "card", // "card_number": "...", // "expiry_month": "...", // "expiry_year": "...", // "cvv": "...", // "billing_address": { ... } // } ``` ```APIDOC Network Token PaymentInstrument: // Example structure for a network token payment instrument // Parameters and fields would be detailed here. // Example: { // "type": "network_token", // "token": "...", // "network": "visa" | "mastercard" | "amex", // "billing_address": { ... } // } ``` -------------------------------- ### Element Token Creation Examples Source: https://docs.methodfi.com/reference/elements/tokens Examples demonstrating how to create an element token using different client libraries and tools. These examples cover cURL, Node.js, and Python, showing the request payload and expected response. ```cURL curl -X POST https://production.methodfi.com/elements/token ``` ```Node.js const method = require('method'); async function createToken() { const token = await method.elements.token.create(); console.log(token); } ``` ```Python import method client = method.Method("YOUR_API_KEY") token = client.elements.token.create() print(token) ``` ```json { "element_token": "pk_elem_qPmypE9wwphr3WL3yTj7JhxjrPzAmK8G" } ``` -------------------------------- ### Example Card Brand Entries Source: https://docs.methodfi.com/reference/accounts/card-brands/list Illustrative examples of card brand data objects, showcasing different combinations of available fields like 'id', 'name', 'art_id', and 'url'. These examples demonstrate the typical data format. ```json { "id": "brand_cms12dmfnDSJ3", "name": "Wells Fargo Cash Wise" } { "art_id": "art_22dfaljaYvd39", "url": "https://static.methodfi.com/card_brands/c8fbea81f8aafca9b475cff3172c0bd4.png", "id": "brand_anDwro12EUHe4", "name": "Wells Fargo Autograph" } { "art_id": "art_2a2ljcmozdxdd", "url": "https://static.methodfi.com/card_brands/f5a54867fb8fa8aafca9b475cff3172a8.png", "id": "brand_38ShenxSulqjs", "name": "Wells Fargo Active Cash" } ``` -------------------------------- ### Elements - Connect Source: https://docs.methodfi.com/elements/connect/overview Documentation for Method Elements Connect, including overview, token creation, launching, and getting results. ```APIDOC GET /elements/connect/overview Description: Overview of the Elements Connect feature. POST /elements/connect/create_connect_token Description: Creates a token to launch Elements Connect. Parameters: - (Request Body): Configuration for the connect token. Returns: - (Object): The generated connect token. POST /elements/connect/launch_connect Description: Initiates the Elements Connect flow. Parameters: - connect_token: The token obtained from create_connect_token. Returns: - (Redirect/Response): Initiates the user flow. GET /elements/connect/get_results Description: Retrieves the results from an Elements Connect session. Parameters: - session_id: The ID of the Connect session. Returns: - (Object): The results of the Connect session. ``` -------------------------------- ### Libraries Overview Source: https://docs.methodfi.com/reference/entities/verification-sessions/create-kba Provides an overview of available libraries. ```APIDOC libraries/overview ```