MethodFi Entity Connects API

openapi: 3.1.0
info:
  title: Method Account Attributes Entity Connects API
  version: '2025-12-01'
  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 `2025-12-01`.\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 `2025-12-01`. 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
- url: https://sandbox.methodfi.com
  description: Sandbox
- url: https://dev.methodfi.com
  description: 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:
    ErrorObject:
      type: object
      required:
      - type
      - code
      - message
      properties:
        type:
          type: string
          description: Error type category.
          enum:
          - invalid_request
          - api_error
          - resource_error
        code:
          type: integer
          description: Numeric error code. Common codes include 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 422 (unprocessable entity), 429 (rate limited), and 500 (internal error).
        sub_type:
          type:
          - string
          - 'null'
          description: More specific error classification.
        message:
          type: string
          description: Human-readable error description.
    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
    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
          items:
            title: EntityConnectExpandableAccount
            oneOf:
            - type: string
              pattern: ^acc_\w+$
            - $ref: '#/components/schemas/Account'
          description: Expandable. List of account IDs connected through this session.
        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
        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.
    UpdateResourceError:
      type:
      - object
      - 'null'
      description: Error details when an account update fails.
      required:
      - type
      - code
      - sub_type
      - message
      properties:
        type:
          type: string
          description: The category of update error.
          enum:
          - UPDATE_FAILED
        code:
          type: integer
          description: Numeric error code (21XXX range).
          enum:
          - 21001
        sub_type:
          type: string
          description: Specific update error classification.
          enum:
          - UPDATE_TEMPORARILY_UNAVAILABLE
        message:
          type: string
          description: Human-readable error description.
      example:
        type: UPDATE_FAILED
        code: 21001
        sub_type: UPDATE_TEMPORARILY_UNAVAILABLE
        message: Update is temporarily unavailable for this account.
    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
    AccountSensitive:
      type: object
      description: Sensitive data for an account.
      required:
      - id
      - account_id
      - status
      - type
      - fields
      - created_at
      - updated_at
      properties:
        id:
          type: string
          description: Unique identifier for the sensitive record.
          pattern: ^astv_\w+$
          example: astv_aTJMbnCjw34yQ
        account_id:
          type: string
          description: The account this sensitive data belongs to.
          pattern: ^acc_\w+$
        status:
          type: string
          description: Current status of the sensitive data request.
          enum:
          - completed
          - pending
          - failed
        type:
          type: string
          description: The type of sensitive data.
        fields:
          type: array
          description: List of sensitive data fields retrieved.
          items:
            type: object
            properties:
              name:
                type: string
                description: Name of the field.
              value:
                type: string
                description: Value of the field.
        error:
          $ref: '#/components/schemas/AccountSensitiveResourceError'
        created_at:
          type: string
          format: date-time
          description: Timestamp when the sensitive record was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the sensitive record was last updated.
    PayoffResourceError:
      type:
      - object
      - 'null'
      description: Error details when a payoff sync fails.
      required:
      - type
      - code
      - sub_type
      - message
      properties:
        type:
          type: string
          description: The category of payoff error.
          enum:
          - PAYOFF_FAILED
        code:
          type: integer
          description: Numeric error code (18XXX range).
          enum:
          - 18001
        sub_type:
          type: string
          description: Specific payoff error classification.
          enum:
          - PAYOFF_TEMPORARILY_UNAVAILABLE
        message:
          type: string
          description: Human-readable error description.
      example:
        type: PAYOFF_FAILED
        code: 18001
        sub_type: PAYOFF_TEMPORARILY_UNAVAILABLE
        message: Payoff is temporarily unavailable for this account.
    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'
    AccountVerificationSessionResourceError:
      type:
      - object
      - 'null'
      description: Error details when an account verification session fails.
      required:
      - type
      - code
      - sub_type
      - message
      properties:
        type:
          type: string
          description: The category of verification session error.
          enum:
          - ACCOUNT_VERIFICATION_SESSION_FAILED
        code:
          type: integer
          description: Numeric error code (16XXX range).
          enum:
          - 16001
          - 16002
          - 16003
          - 16004
        sub_type:
          type: string
          description: Specific verification session error classification.
          enum:
          - VERIFICATION_TYPE_NOT_SUPPORTED
          - INVALID_DETAILS
          - VERIFICATION_SESSION_ATTEMPT_LIMIT_REACHED
          - MICRO_DEPOSITS_FAILED
        message:
          type: string
          description: Human-readable error description.
      example:
        type: ACCOUNT_VERIFICATION_SESSION_FAILED
        code: 16001
        sub_type: VERIFICATION_TYPE_NOT_SUPPORTED
        message: The verification type provided is not supported for the merchant.
    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'
    AccountPaymentInstrument:
      type: object
      description: A payment instrument for an account.
      required:
      - id
      - account_id
      - status
      - type
      - created_at
      - updated_at
      properties:
        id:
          type: string
          description: Unique identifier for the payment instrument.
          pattern: ^pmt_inst_\w+$
          example: pmt_inst_aTJMbnCjw34yQ
        account_id:
          type: string
          description: The account this payment instrument belongs to.
          pattern: ^acc_\w+$
        status:
          type: string
          description: Current status of the payment instrument.
          enum:
          - pending
          - in_progress
          - completed
        type:
          type: string
          description: The type of payment instrument.
          enum:
          - card
          - network_token
          - inbound_achwire_payment
        chargeable:
          type: boolean
          description: Whether this payment instrument is currently chargeable.
        card:
          type:
          - object
          - 'null'
          description: Card details. Present when type is card.
          properties:
            number:
              type: string
              description: The card number.
            exp_month:
              type: string
              description: Card expiration month.
            exp_year:
              type: string
              description: Card expiration year.
            billing_zip_code:
              type: string
              description: Billing zip code.
        network_token:
          type:
          - object
          - 'null'
          description: Network token details. Present when type is network_token.
          properties:
            token:
              type: string
              description: The network token value.
        inbound_achwire_payment:
          type:
          - object
          - 'null'
          description: ACH/wire payment details. Present when type is inbound_achwire_payment.
          properties:
            account_number:
              type: string
              description: The account number.
            routing_number:
              type: string
              description: The routing number.
        error:
          $ref: '#/components/schemas/ResourceError'
        created_at:
          type: string
          format: date-time
          description: Timestamp when the payment instrument was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the payment instrument was last updated.
    EntityConnectResponse:
      allOf:
      - $ref: '#/components/schemas/SuccessEnvelope'
      - type: object
        properties:
          data:
            $ref: '#/components/schemas/EntityConnect'
    MerchantProviderIds:
      type: object
      properties:
        plaid:
          type: array
          items:
            type: string
        mx:
          type: array
          items:
            type: string
        finicity:
          type: array
          items:
            type: string
        dpp:
          type: array
          items:
            type: string
        rpps:
          type: array
          items:
            type: string
    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'
    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'
    AccountExpandableCardBrand:
      title: AccountExpandableCardBrand
      description: 'The latest card brand ID. This field is expandable. When expanded, returns the full AccountCardBrand object.

        '
      oneOf:
      - type: string
        pattern: ^cbrd_\w+$
      - type: 'null'
      - $ref: '#/components/schemas/AccountCardBrand'
    Metadata:
      type:
      - object
      - 'null'
      additionalProperties: true
      description: Arbitrary key-value metadata attached to the resource.
    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.
    EntityConnectListResponse:
      allOf:
      - $ref: '#/components/schemas/ListEnvelope'
      - type: object
        properties:
          data:
            type: array
            items:
              $ref: '#/components/schemas/EntityConnect'
    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'
    MerchantType:
      type: string
      enum:
      - auto_loan
      - bank
      - bnpl
      - business_loan
      - city
      - collection
      - county
      - credit_builder
      - credit_card
      - electric_utility
      - fintech
      - home_equity_loan
      - home_loan
      - insurance
      - internet_utility
      - loan
      - medical
      - mortgage
      - personal_loan
      - student_loan
      - student_loans
      - subscription
      - telephone_utility
      - television_utility
      - unknown
      - utility
      - waste_utility
      - water_utility
    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'
    AccountSen

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