Method Financial Entity Connects API

openapi: 3.2.0
info:
  title: Method Entity Connects API
  version: '2026-03-30'
  license:
    name: Proprietary
    url: https://methodfi.com
  description: "The Method API enables you to retrieve financial data, create payments, and manage\nentities and accounts programmatically. This specification covers the public API\nsurface for version `2026-03-30`.\n\n## Authentication\n\nMost API requests require a Bearer token in the `Authorization` header.\nUse your secret key (`sk_...`) for server-side requests and public key (`pk_...`)\nfor client-side Element requests. Public Message-Level Encryption key discovery\nendpoints are documented separately and do not require authentication.\n\n## Versioning\n\nThe API version is selected via the `Method-Version` header. This spec targets\nversion `2026-03-30`. The SDK sets this header automatically.\n\n## Response Envelope\n\nMost JSON responses are wrapped in a standard envelope:\n\n```json\n{\n  \"success\": true,\n  \"data\": { ... },\n  \"message\": null\n}\n```\n\nThe `/.well-known/jwks.json` endpoint is an exception and returns a bare JWK set.\n\n## Pagination\n\nList endpoints return pagination metadata in response headers:\n`Pagination-Page`, `Pagination-Page-Count`, `Pagination-Page-Limit`,\n`Pagination-Total-Count`, `Pagination-Page-Cursor-Prev`, `Pagination-Page-Cursor-Next`.\n\n## Expandable Fields\n\nCertain resource fields can be expanded from IDs to full objects using the\n`expand` query parameter. Maximum nesting depth is 4 levels.\n"
  contact:
    name: Method Financial
    url: https://methodfi.com
    email: team@methodfi.com
servers:
- url: https://production.methodfi.com
  description: Production
  x-fern-server-name: Production
- url: https://sandbox.methodfi.com
  description: Sandbox
  x-fern-server-name: Sandbox
- url: https://dev.methodfi.com
  description: Development
  x-fern-server-name: Development
security:
- SecretKey: []
tags:
- name: Entity Connects
  description: Account connection sessions for entities
paths:
  /entities/{entityId}/connect:
    get:
      operationId: listEntityConnects
      summary: List all entity connect sessions
      description: Returns a list of connect sessions for the specified entity.
      tags:
      - Entity Connects
      security:
      - SecretKey: []
      parameters:
      - $ref: '#/components/parameters/method_version'
      - $ref: '#/components/parameters/EntityIdParam'
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PageLimitParam'
      - $ref: '#/components/parameters/PageCursorParam'
      - $ref: '#/components/parameters/FromDateParam'
      - $ref: '#/components/parameters/ToDateParam'
      - $ref: '#/components/parameters/expand_entity_connects'
      responses:
        '200':
          description: A list of entity connect sessions.
          headers:
            Pagination-Page:
              description: Current page number.
              schema:
                type: integer
            Pagination-Page-Count:
              description: Total number of pages.
              schema:
                type: integer
            Pagination-Page-Limit:
              description: Number of items per page.
              schema:
                type: integer
            Pagination-Total-Count:
              description: Total number of items across all pages.
              schema:
                type: integer
            Pagination-Page-Cursor-Prev:
              description: Cursor for the previous page, if available.
              schema:
                type:
                - string
                - 'null'
            Pagination-Page-Cursor-Next:
              description: Cursor for the next page, if available.
              schema:
                type:
                - string
                - 'null'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityConnectListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
    post:
      operationId: createEntityConnect
      summary: Create an entity connect session
      description: Creates a new connect session for the specified entity.
      tags:
      - Entity Connects
      security:
      - SecretKey: []
      parameters:
      - $ref: '#/components/parameters/method_version'
      - $ref: '#/components/parameters/idempotency_key'
      - $ref: '#/components/parameters/EntityIdParam'
      - $ref: '#/components/parameters/expand_entity_connects'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                products:
                  type: array
                  description: Products to request during the connect session.
                  items:
                    type: string
                subscriptions:
                  type: array
                  description: Subscriptions to request during the connect session.
                  items:
                    type: string
      responses:
        '200':
          description: The created entity connect session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityConnectResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /entities/{entityId}/connect/{cxnId}:
    get:
      operationId: retrieveEntityConnect
      summary: Retrieve an entity connect session
      description: Returns a single entity connect session by its identifier.
      tags:
      - Entity Connects
      security:
      - SecretKey: []
      parameters:
      - $ref: '#/components/parameters/method_version'
      - $ref: '#/components/parameters/EntityIdParam'
      - $ref: '#/components/parameters/EntityConnectIdParam'
      - $ref: '#/components/parameters/expand_entity_connects'
      responses:
        '200':
          description: The requested entity connect session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityConnectResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /entities/{entityId}/manual_connect:
    post:
      operationId: createEntityManualConnect
      summary: Create an entity manual connect session
      description: Creates a new manual connect session for the specified entity.
      tags:
      - Entity Connects
      security:
      - SecretKey: []
      parameters:
      - $ref: '#/components/parameters/method_version'
      - $ref: '#/components/parameters/idempotency_key'
      - $ref: '#/components/parameters/EntityIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - bureau
              - tradelines
              properties:
                bureau:
                  type: string
                  description: The credit bureau source for the manual connect session.
                  enum:
                  - equifax
                  - transunion
                tradelines:
                  type: array
                  description: List of tradeline objects to manually connect.
                  items:
                    type: object
                    required:
                    - type_code
                    - portfolio_type_code
                    - designator_code
                    - number
                    - creditor_name
                    - creditor_code
                    - balance
                    - highest_balance
                    - credit_limit
                    - term
                    - next_payment_minimum_amount
                    - last_payment_amount
                    - payment_history
                    - past_due_amount
                    - delinquency_charge_off_amount
                    - opened_at
                    - closed_at
                    - last_activity_date
                    - reported_date
                    - next_payment_due_date
                    - last_payment_date
                    - delinquency_first_start_date
                    - narrative_codes
                    properties:
                      type_code:
                        type:
                        - string
                        - 'null'
                        description: The type code of the tradeline.
                      portfolio_type_code:
                        type:
                        - string
                        - 'null'
                        description: The portfolio type code of the tradeline.
                      designator_code:
                        type:
                        - string
                        - 'null'
                        description: The designator code of the tradeline.
                      number:
                        type:
                        - string
                        - 'null'
                        description: The account number of the tradeline.
                      creditor_name:
                        type:
                        - string
                        - 'null'
                        description: The name of the creditor.
                      creditor_code:
                        type:
                        - string
                        - 'null'
                        description: The code of the creditor.
                      balance:
                        type:
                        - number
                        - 'null'
                        description: The current balance of the tradeline.
                      highest_balance:
                        type:
                        - number
                        - 'null'
                        description: The highest balance of the tradeline.
                      credit_limit:
                        type:
                        - number
                        - 'null'
                        description: The credit limit of the tradeline.
                      term:
                        type:
                        - number
                        - 'null'
                        description: The term of the tradeline in months.
                      next_payment_minimum_amount:
                        type:
                        - number
                        - 'null'
                        description: The minimum amount due for the next payment.
                      last_payment_amount:
                        type:
                        - number
                        - 'null'
                        description: The amount of the last payment.
                      payment_history:
                        type:
                        - array
                        - 'null'
                        description: The payment history of the tradeline.
                        items:
                          type: string
                      past_due_amount:
                        type:
                        - number
                        - 'null'
                        description: The past due amount of the tradeline.
                      delinquency_charge_off_amount:
                        type:
                        - number
                        - 'null'
                        description: The delinquency charge-off amount.
                      opened_at:
                        type:
                        - string
                        - 'null'
                        description: The date the tradeline was opened (YYYY-MM-DD).
                        format: date
                      closed_at:
                        type:
                        - string
                        - 'null'
                        description: The date the tradeline was closed (YYYY-MM-DD).
                        format: date
                      last_activity_date:
                        type:
                        - string
                        - 'null'
                        description: The date of the last activity (YYYY-MM-DD).
                        format: date
                      reported_date:
                        type:
                        - string
                        - 'null'
                        description: The date the tradeline was reported (YYYY-MM-DD).
                        format: date
                      next_payment_due_date:
                        type:
                        - string
                        - 'null'
                        description: The date the next payment is due (YYYY-MM-DD).
                        format: date
                      last_payment_date:
                        type:
                        - string
                        - 'null'
                        description: The date of the last payment (YYYY-MM-DD).
                        format: date
                      delinquency_first_start_date:
                        type:
                        - string
                        - 'null'
                        description: The date of the first delinquency (YYYY-MM-DD).
                        format: date
                      narrative_codes:
                        type:
                        - array
                        - 'null'
                        description: Narrative codes associated with the tradeline.
                        items:
                          type: object
                          properties:
                            code:
                              type:
                              - string
                              - 'null'
                              description: The narrative code.
                            description:
                              type:
                              - string
                              - 'null'
                              description: The description of the narrative code.
                      external_id:
                        type:
                        - string
                        - 'null'
                        description: An external identifier for the tradeline.
      responses:
        '200':
          description: The created entity manual connect session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityConnectResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
  /entities/{entityId}/manual_connect/{mcxnId}:
    get:
      operationId: retrieveEntityManualConnect
      summary: Retrieve an entity manual connect session
      description: Returns a single entity manual connect session by its identifier.
      tags:
      - Entity Connects
      security:
      - SecretKey: []
      parameters:
      - $ref: '#/components/parameters/method_version'
      - $ref: '#/components/parameters/EntityIdParam'
      - $ref: '#/components/parameters/EntityManualConnectIdParam'
      responses:
        '200':
          description: The requested entity manual connect session.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityConnectResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    ListEnvelope:
      type: object
      description: Standard envelope for successful responses that return a list payload.
      required:
      - success
      - data
      - message
      properties:
        success:
          type: boolean
          description: Always `true` for successful responses.
        data:
          description: Operation-specific list payload.
        message:
          type:
          - string
          - 'null'
      example:
        success: true
        data: []
        message: null
    Merchant:
      type: object
      required:
      - id
      - parent_name
      - name
      - logo
      - type
      - provider_ids
      - is_temp
      - account_number_formats
      properties:
        id:
          type: string
          description: Unique identifier for the merchant.
          example: mch_aTJMbnCjw34yQ
        parent_name:
          type: string
          description: Name of the parent merchant group.
          example: Chase
        name:
          type: string
          description: Display name of the merchant.
          example: Chase - Credit Cards
        logo:
          type: string
          description: URL of the merchant logo.
          example: https://static.methodfi.com/logos/chase.png
        type:
          $ref: '#/components/schemas/MerchantType'
          description: Type of accounts supported by this merchant.
        provider_ids:
          $ref: '#/components/schemas/MerchantProviderIds'
        is_temp:
          type: boolean
          description: Whether this is a temporary merchant entry.
        account_number_formats:
          type: array
          items:
            type: string
          description: Accepted account number formats.
    AccountExpandableAttribute:
      title: AccountExpandableAttribute
      description: 'The latest attribute ID. This field is expandable. When expanded, returns the full AccountAttribute object.

        '
      oneOf:
      - type: string
        pattern: ^acc_attr_\w+$
      - type: 'null'
      - $ref: '#/components/schemas/AccountAttribute'
    Account:
      type: object
      description: 'An Account represents a financial account (ACH, liability, clearing, or debit card) associated with an Entity. The `type` field indicates which nested details object (`ach`, `liability`, `clearing`, or `debit_card`) is populated. `type` is null for accounts that are disabled before a type was determined.

        '
      required:
      - id
      - holder_id
      - type
      - status
      - consent_status
      - products
      - restricted_products
      - created_at
      - updated_at
      properties:
        id:
          type: string
          description: Unique identifier for the account.
          pattern: ^acc_\w+$
          example: acc_b9q2XVAnNFbp3
        holder_id:
          type: string
          description: The entity ID that owns this account.
          pattern: ^ent_\w+$
          example: ent_au22b1fbFJbp8
        type:
          type:
          - string
          - 'null'
          description: The type of account. Null for accounts that are disabled before a type was determined.
          enum:
          - ach
          - liability
          - clearing
          - debit_card
          - null
        status:
          type: string
          description: Current status of the account.
          enum:
          - active
          - disabled
          - processing
          - pending_exchange
          - closed
        consent_status:
          type: string
          description: Current consent status for data access on this account.
          enum:
          - pending
          - withdrawn
          - approved
        ach:
          $ref: '#/components/schemas/AccountACH'
        liability:
          $ref: '#/components/schemas/AccountLiability'
        clearing:
          $ref: '#/components/schemas/AccountClearing'
        debit_card:
          $ref: '#/components/schemas/AccountDebitCard'
        error:
          $ref: '#/components/schemas/AccountResourceError'
        metadata:
          $ref: '#/components/schemas/Metadata'
        products:
          type: array
          description: Products currently active for this account.
          items:
            type: string
        restricted_products:
          type: array
          description: Products restricted from this account.
          items:
            type: string
        subscriptions:
          type: array
          description: Subscriptions currently active for this account. Only present for liability accounts.
          items:
            type: string
        available_subscriptions:
          type: array
          description: Subscriptions available to be enrolled for this account. Only present for liability accounts.
          items:
            type: string
        restricted_subscriptions:
          type: array
          description: Subscriptions restricted from this account. Only present for liability accounts.
          items:
            type: string
        latest_verification_session:
          title: AccountExpandableLatestVerificationSession
          description: 'The latest verification session ID. This field is expandable. When expanded, returns the full AccountVerificationSession object.

            '
          oneOf:
          - type: string
            pattern: ^avf_\w+$
          - type: 'null'
          - $ref: '#/components/schemas/AccountVerificationSession'
        balance:
          $ref: '#/components/schemas/AccountExpandableBalance'
        payoff:
          $ref: '#/components/schemas/AccountExpandablePayoff'
        payment_instrument:
          $ref: '#/components/schemas/AccountExpandablePaymentInstrument'
        card_brand:
          $ref: '#/components/schemas/AccountExpandableCardBrand'
        update:
          $ref: '#/components/schemas/AccountExpandableUpdate'
        attribute:
          $ref: '#/components/schemas/AccountExpandableAttribute'
        sensitive:
          $ref: '#/components/schemas/AccountExpandableSensitive'
        created_at:
          type: string
          format: date-time
          description: Timestamp when the account was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the account was last updated.
    AccountDebitCard:
      type:
      - object
      - 'null'
      description: Debit card account details. Present when `type` is `debit_card`.
      properties:
        network:
          type: string
          description: The card network.
        mask:
          type: string
          description: Last 4 digits of the card number.
        issuer:
          type: string
          description: The card issuer.
    AccountSensitiveResourceError:
      type:
      - object
      - 'null'
      description: Error details when retrieving account sensitive data fails.
      required:
      - type
      - code
      - sub_type
      - message
      properties:
        type:
          type: string
          description: The category of sensitive data error.
          enum:
          - ACCOUNT_SENSITIVE_FAILED
        code:
          type: integer
          description: Numeric error code (17XXX range).
          enum:
          - 17001
        sub_type:
          type: string
          description: Specific sensitive data error classification.
          enum:
          - ACCOUNT_SENSITIVE_FAILED_VERIFICATION_REQUIRED
        message:
          type: string
          description: Human-readable error description.
      example:
        type: ACCOUNT_SENSITIVE_FAILED
        code: 17001
        sub_type: ACCOUNT_SENSITIVE_FAILED_VERIFICATION_REQUIRED
        message: Account sensitive failed due to missing required verification.
    AccountExpandablePaymentInstrument:
      title: AccountExpandablePaymentInstrument
      description: 'The latest payment instrument ID. This field is expandable. When expanded, returns the full AccountPaymentInstrument object.

        '
      oneOf:
      - type: string
        pattern: ^pmt_inst_\w+$
      - type: 'null'
      - $ref: '#/components/schemas/AccountPaymentInstrument'
    ErrorEnvelope:
      type: object
      required:
      - success
      - data
      - message
      properties:
        success:
          type: boolean
          description: Always `false` for error responses.
        data:
          type: object
          required:
          - error
          properties:
            error:
              $ref: '#/components/schemas/ErrorObject'
        message:
          type: string
    ResourceError:
      type:
      - object
      - 'null'
      required:
      - type
      - code
      - message
      properties:
        type:
          type: string
        code:
          type: integer
        sub_type:
          type:
          - string
          - 'null'
        message:
          type: string
    EntityConnectResponse:
      allOf:
      - $ref: '#/components/schemas/SuccessEnvelope'
      - type: object
        properties:
          data:
            $ref: '#/components/schemas/EntityConnect'
    BalanceResourceError:
      type:
      - object
      - 'null'
      description: Error details when a balance sync fails.
      required:
      - type
      - code
      - sub_type
      - message
      properties:
        type:
          type: string
          description: The category of balance error.
          enum:
          - BALANCE_FAILED
        code:
          type: integer
          description: Numeric error code (20XXX range).
          enum:
          - 20001
        sub_type:
          type: string
          description: Specific balance error classification.
          enum:
          - BALANCE_TEMPORARILY_UNAVAILABLE
        message:
          type: string
          description: Human-readable error description.
      example:
        type: BALANCE_FAILED
        code: 20001
        sub_type: BALANCE_TEMPORARILY_UNAVAILABLE
        message: Balance is temporarily unavailable for this account.
    AccountExpandableSensitive:
      title: AccountExpandableSensitive
      description: 'The latest sensitive ID. This field is expandable. When expanded, returns the full AccountSensitive object.

        '
      oneOf:
      - type: string
        pattern: ^astv_\w+$
      - type: 'null'
      - $ref: '#/components/schemas/AccountSensitive'
    AccountBalance:
      type: object
      description: A balance record for an account.
      required:
      - id
      - account_id
      - status
      - amount
      - created_at
      - updated_at
      properties:
        id:
          type: string
          description: Unique identifier for the balance.
          pattern: ^bal_\w+$
          example: bal_dKe9ehC3hEBYy
        account_id:
          type: string
          description: The account this balance belongs to.
          pattern: ^acc_\w+$
        status:
          type: string
          description: Current status of the balance request.
          enum:
          - completed
          - pending
          - failed
        amount:
          type:
          - number
          - 'null'
          description: The balance amount in cents.
        error:
          $ref: '#/components/schemas/BalanceResourceError'
        created_at:
          type: string
          format: date-time
          description: Timestamp when the balance was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the balance was last updated.
    AccountExpandablePayoff:
      title: AccountExpandablePayoff
      description: 'The latest payoff ID. This field is expandable. When expanded, returns the full AccountPayoff object.

        '
      oneOf:
      - type: string
        pattern: ^pyf_\w+$
      - type: 'null'
      - $ref: '#/components/schemas/AccountPayoff'
    SuccessEnvelope:
      type: object
      description: Standard envelope for successful responses that return a single payload.
      required:
      - success
      - data
      - message
      properties:
        success:
          type: boolean
          description: Always `true` for successful responses.
        data:
          description: Operation-specific response payload.
        message:
          type:
          - string
          - 'null'
      example:
        success: true
        data: {}
        message: null
    AccountExpandableUpdate:
      title: AccountExpandableUpdate
      description: 'The latest update ID. This field is expandable. When expanded, returns the full AccountUpdate object.

        '
      oneOf:
      - type: string
        pattern: ^upd_\w+$
      - type: 'null'
      - $ref: '#/components/schemas/AccountUpdate'
    AccountExpandableBalance:
      title: AccountExpandableBalance
      description: 'The latest balance ID. This field is expandable. When expanded, returns the full AccountBalance object.

        '
      oneOf:
      - type: string
        pattern: ^bal_\w+$
      - type: 'null'
      - $ref: '#/components/schemas/AccountBalance'
    EntityConnect:
      type: object
      required:
      - id
      - entity_id
      - status
      - accounts
      - requested_products
      - requested_subscriptions
      - created_at
      - updated_at
      properties:
        id:
          type: string
          description: Unique identifier for the connect session.
          example: cxn_iENwGBMDnr7sJ
        entity_id:
          type: string
          description: The ID of the entity this connect session belongs to.
          example: ent_au22b1fbFJbp8
        status:
          type: string
          description: Status of the connect session.
          enum:
          - completed
          - in_progress
          - pending
          - failed
        accounts:
          type:
          - array
          - 'null'
          items:
            title: EntityConnectExpandableAccount
            oneOf:
            - type: string
              pattern: ^acc_\w+$
            - $ref: '#/components/schemas/Account'
          description: Expandable. List of account IDs connected through this session. Null while the connect session is still pending.
        requested_products:
          type:
          - array
          - 'null'
          description: Products requested for this connect session.
          items:
            type: string
        requested_subscriptions:
          type:
          - array
          - 'null'
          description: Subscriptions requested for this connect session.
          items:
            type: string
        files:
          type:
          - array
          - 'null'
          description: Files associated with this connect session (e.g. manual connect uploads).
          items:
            $ref: '#/components/schemas/JsonObject'
        error:
          type:
          - object
          - 'null'
          description: Error details if the resource encountered an error.
          allOf:
          - $ref: '#/components/schemas/ConnectResourceError'
        created_at:
          type: string
          format: date-time
          description: Timestamp when the connect session was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the connect session was last updated.
    AccountAttribute:
      type: object
      description: An attribute record for an account containing financia

# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/method-financial/refs/heads/main/openapi/method-financial-entity-connects-api-openapi.yml