MethodFi Entity Consent API

openapi: 3.2.0
info:
  title: Method Entity Consent 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 Consent
  description: Consent management for entities
paths:
  /entities/{entityId}/consent:
    post:
      operationId: updateEntityConsent
      summary: Update entity consent
      description: Grants or withdraws consent for the specified entity.
      tags:
      - Entity Consent
      security:
      - SecretKey: []
      parameters:
      - $ref: '#/components/parameters/method_version'
      - $ref: '#/components/parameters/EntityIdParam'
      - $ref: '#/components/parameters/idempotency_key'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEntityConsentRequest'
            example:
              type: withdraw
              reason: entity_withdrew_consent
      responses:
        '200':
          description: The updated entity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityResponse'
        '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'
components:
  schemas:
    VerificationSessionResourceError:
      type:
      - object
      - 'null'
      description: Error details when an entity verification session fails.
      required:
      - type
      - code
      - sub_type
      - message
      properties:
        type:
          type: string
          description: The category of verification session error.
          enum:
          - VERIFICATION_SESSION_FAILED
        code:
          type: integer
          description: Numeric error code (19XXX range).
          enum:
          - 19001
          - 19002
          - 19003
          - 19004
        sub_type:
          type: string
          description: Specific verification session error classification.
          enum:
          - VERIFICATION_SESSION_EXPIRED
          - VERIFICATION_SESSION_INCORRECT_SMS_CODE
          - VERIFICATION_SESSION_FAILED_SNA
          - VERIFICATION_SESSION_FAILED_INVALID_ANSWER
        message:
          type: string
          description: Human-readable error description.
      example:
        type: VERIFICATION_SESSION_FAILED
        code: 19001
        sub_type: VERIFICATION_SESSION_EXPIRED
        message: The verification session has expired. Please re-initiate the verification process.
    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.
    EntityIndividualResource:
      allOf:
      - $ref: '#/components/schemas/EntityBase'
      - type: object
        required:
        - products
        - restricted_products
        - subscriptions
        - available_subscriptions
        - restricted_subscriptions
        properties:
          type:
            type: string
            enum:
            - individual
          individual:
            $ref: '#/components/schemas/EntityIndividual'
          verification:
            $ref: '#/components/schemas/EntityVerification'
          connect:
            $ref: '#/components/schemas/EntityExpandableConnect'
          credit_score:
            $ref: '#/components/schemas/EntityExpandableCreditScore'
          attribute:
            $ref: '#/components/schemas/EntityExpandableAttribute'
          vehicle:
            $ref: '#/components/schemas/EntityExpandableVehicle'
          products:
            type: array
            items:
              type: string
            description: Products currently active for this entity.
          restricted_products:
            type: array
            items:
              type: string
            description: Products restricted for this entity.
          subscriptions:
            type: array
            items:
              type: string
            description: Active subscriptions for this entity.
          available_subscriptions:
            type: array
            items:
              type: string
            description: Subscriptions available for this entity.
          restricted_subscriptions:
            type: array
            items:
              type: string
            description: Subscriptions restricted for this entity.
    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
    EntityExpandableCreditScore:
      title: EntityExpandableCreditScore
      description: Expandable. The entity credit score ID or expanded credit score object.
      example: crs_pn4ca33GRnrJm
      oneOf:
      - type: string
        pattern: ^crs_\w+$
      - type: 'null'
      - $ref: '#/components/schemas/EntityCreditScore'
    EntityResponse:
      allOf:
      - $ref: '#/components/schemas/SuccessEnvelope'
      - type: object
        properties:
          data:
            $ref: '#/components/schemas/Entity'
      example:
        success: true
        data:
          id: ent_au22b1fbFJbp8
          type: individual
          individual:
            first_name: Jane
            last_name: Doe
            phone: '+15125550123'
            email: jane@example.com
            dob: '1990-05-21'
          address:
            line1: 123 Main St
            line2: null
            city: Austin
            state: TX
            zip: '78701'
          verification:
            identity:
              verified: true
              matched: true
              latest_verification_session: evf_aBcDeFgHiJkLm
              methods: []
            phone:
              verified: true
              latest_verification_session: evf_nOpQrStUvWxYz
              methods: []
          connect: null
          credit_score: null
          attribute: null
          vehicle: null
          products:
          - connect
          - credit_score
          restricted_products:
          - attribute
          - identity
          - manual_connect
          - vehicle
          subscriptions: []
          available_subscriptions:
          - connect
          - credit_score
          restricted_subscriptions:
          - attribute
          status: active
          error: null
          metadata: null
          created_at: '2024-12-05T10:05:21.742Z'
          updated_at: '2024-12-05T10:11:17.823Z'
        message: null
    ResourceError:
      type:
      - object
      - 'null'
      required:
      - type
      - code
      - message
      properties:
        type:
          type: string
        code:
          type: integer
        sub_type:
          type:
          - string
          - 'null'
        message:
          type: string
    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'
    EntityCorporationOwner:
      type: object
      properties:
        first_name:
          type: string
          description: First name of the owner.
        last_name:
          type: string
          description: Last name of the owner.
        phone:
          type: string
          description: Phone number of the owner.
          pattern: ^\+\d{10,15}$
        email:
          type: string
          description: Email address of the owner.
          format: email
        dob:
          type: string
          format: date
          description: Date of birth of the owner (YYYY-MM-DD).
        address:
          $ref: '#/components/schemas/Address'
    EntityAttributeData:
      type:
      - object
      - 'null'
      description: Financial health and credit attribute data.
      properties:
        credit_health_credit_card_usage:
          type:
          - object
          - 'null'
          description: Credit card usage health indicator.
          properties:
            value:
              type:
              - number
              - 'null'
              description: The attribute value.
            rating:
              type: string
              description: Rating for this attribute.
            metadata:
              type:
              - object
              - 'null'
              description: Additional metadata.
        credit_health_derogatory_marks:
          type:
          - object
          - 'null'
          description: Derogatory marks health indicator.
          properties:
            value:
              type:
              - number
              - 'null'
              description: The attribute value.
            rating:
              type: string
              description: Rating for this attribute.
            metadata:
              type:
              - object
              - 'null'
              description: Additional metadata.
        credit_health_hard_inquiries:
          type:
          - object
          - 'null'
          description: Hard inquiries health indicator.
          properties:
            value:
              type:
              - number
              - 'null'
              description: The attribute value.
            rating:
              type: string
              description: Rating for this attribute.
            metadata:
              type:
              - object
              - 'null'
              description: Additional metadata.
        credit_health_soft_inquiries:
          type:
          - object
          - 'null'
          description: Soft inquiries health indicator.
          properties:
            value:
              type:
              - number
              - 'null'
              description: The attribute value.
            rating:
              type: string
              description: Rating for this attribute.
            metadata:
              type:
              - object
              - 'null'
              description: Additional metadata.
        credit_health_total_accounts:
          type:
          - object
          - 'null'
          description: Total accounts health indicator.
          properties:
            value:
              type:
              - number
              - 'null'
              description: The attribute value.
            rating:
              type: string
              description: Rating for this attribute.
            metadata:
              type:
              - object
              - 'null'
              description: Additional metadata.
        credit_health_open_accounts:
          type:
          - object
          - 'null'
          description: Open accounts health indicator.
          properties:
            value:
              type:
              - number
              - 'null'
              description: The attribute value.
            rating:
              type: string
              description: Rating for this attribute.
            metadata:
              type:
              - object
              - 'null'
              description: Additional metadata.
        credit_health_credit_age:
          type:
          - object
          - 'null'
          description: Credit age health indicator.
          properties:
            value:
              type:
              - number
              - 'null'
              description: The attribute value.
            rating:
              type: string
              description: Rating for this attribute.
            metadata:
              type:
              - object
              - 'null'
              description: Additional metadata.
        credit_health_payment_history:
          type:
          - object
          - 'null'
          description: Payment history health indicator.
          properties:
            value:
              type:
              - number
              - 'null'
              description: The attribute value.
            rating:
              type: string
              description: Rating for this attribute.
            metadata:
              type:
              - object
              - 'null'
              description: Additional metadata.
        credit_health_entity_delinquent:
          type:
          - object
          - 'null'
          description: Entity delinquency health indicator.
          properties:
            value:
              type:
              - number
              - 'null'
              description: The attribute value.
            rating:
              type: string
              description: Rating for this attribute.
            metadata:
              type:
              - object
              - 'null'
              description: Additional metadata.
    EntityVerification:
      type:
      - object
      - 'null'
      properties:
        identity:
          $ref: '#/components/schemas/EntityVerificationIdentity'
        phone:
          $ref: '#/components/schemas/EntityVerificationPhone'
    AccountAttribute:
      type: object
      description: An attribute record for an account containing financial data attributes.
      required:
      - id
      - account_id
      - status
      - attributes
      - created_at
      - updated_at
      properties:
        id:
          type: string
          description: Unique identifier for the account attribute.
          pattern: ^acc_attr_\w+$
          example: acc_attr_eTJMbnCjw34yQ
        account_id:
          type: string
          description: The account this attribute belongs to.
          pattern: ^acc_\w+$
        status:
          type: string
          description: Current status of the attribute request.
          enum:
          - completed
          - pending
          - failed
        attributes:
          type: object
          description: Financial data attributes for the account.
          additionalProperties: true
        error:
          $ref: '#/components/schemas/ResourceError'
        created_at:
          type: string
          format: date-time
          description: Timestamp when the attribute was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the attribute was last updated.
    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
    EntityCorporation:
      type:
      - object
      - 'null'
      properties:
        name:
          type:
          - string
          - 'null'
          description: Legal name of the corporation.
        dba:
          type:
          - string
          - 'null'
          description: Doing business as name.
        ein:
          type:
          - string
          - 'null'
          description: Employer Identification Number.
        owners:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityCorporationOwner'
          description: List of beneficial owners.
    EntityExpandableAttribute:
      title: EntityExpandableAttribute
      description: Expandable. The entity attribute ID or expanded attribute object.
      example: attr_QwMjMDEwMTY1
      oneOf:
      - type: string
        pattern: ^attr_\w+$
      - type: 'null'
      - $ref: '#/components/schemas/EntityAttribute'
    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'
    AccountClearing:
      type:
      - object
      - 'null'
      description: Clearing account details. Present when `type` is `clearing`.
      properties:
        type:
          type: string
          description: The type of clearing account.
          enum:
          - single_use
          - multi_use
        routing:
          type: string
          description: The clearing routing number.
        number:
          type: string
          description: The clearing account number.
    CreditScoreResourceError:
      type:
      - object
      - 'null'
      description: Error details when a credit score pull fails.
      required:
      - type
      - code
      - sub_type
      - message
      properties:
        type:
          type: string
          description: The category of credit score error.
          enum:
          - CREDIT_SCORE_FAILED
        code:
          type: integer
          description: Numeric error code (23XXX range).
          enum:
          - 23001
        sub_type:
          type: string
          description: Specific credit score error classification.
          enum:
          - CREDIT_SCORE_FAILED_TEMPORARILY_UNAVAILABLE
        message:
          type: string
          description: Human-readable error description.
      example:
        type: CREDIT_SCORE_FAILED
        code: 23001
        sub_type: CREDIT_SCORE_FAILED_TEMPORARILY_UNAVAILABLE
        message: Credit Score is temporarily unavailable for this entity.
    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.
    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.
    AccountLiability:
      type:
      - object
      - 'null'
      description: Liability account details. Present when `type` is `liability`.
      required:
      - mch_id
      - mask
      - ownership
      - fingerprint
      - type
      - sub_type
      - name
      properties:
        mch_id:
          title: AccountLiabilityExpandableMerchant
          description: The merchant ID associated with this liability.
          oneOf:
          - type: string
            pattern: ^mch_\w+$
          - $ref: '#/components/schemas/Merchant'
        mask:
          type:
          - string
          - 'null'
          description: Last 4 digits of the account number.
          example: '4321'
        ownership:
          type:
          - string
          - 'null'
          description: Ownership type of the account.
          enum:
          - primary
          - authorized
          - joint
          - unknown
          - null
        fingerprint:
          type:
          - string
          - 'null'
          description: Unique fingerprint for de-duplication.
        type:
          type: string
          description: The type of liability.
          enum:
          - credit_card
          - auto_loan
          - mortgage
          - personal_loan
          - student_loan
          - student_loans
          - collection
          - credit_builder
          - insurance
          - loan
          - medical
          - utility
          - bnpl
          - fintech
        sub_type:
          type:
          - string
          - 'null'
          description: More specific classification of the liability type.
        name:
          type:
          - string
          - 'null'
          description: Display name of the liability account.
    AccountCardBrand:
      type: object
      description: Card brand information for an account.
      required:
      - id
      - account_id
      - status
      - created_at
      - updated_at
      properties:
        id:
          type: string
          description: Unique identifier for the card brand.
          pattern: ^cbrd_\w+$
          example: cbrd_aTJMbnCjw34yQ
        account_id:
          type: string
          description: The account this card brand belongs to.
          pattern: ^acc_\w+$
        brands:
          type:
          - array
          - 'null'
          description: Array of card brand entries for this account.
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier for the brand entry.
              card_product_id:
                type:
                - string
                - 'null'
                description: Associated card product ID.
              description:
                type: string
                description: Description of the brand.
              name:
                type: string
                description: Name of the brand.
              issuer:
                type: string
                description: The card issuer.
              network:
                type: string
                description: The card network.
              network_tier:
                type: string
                description: The tier of the card network.
              type:
                type:
                - string
                - 'null'
                description: The brand type.
              url:
                type: string
                description: URL for the brand image.
        source:
          type:
          - string
          - 'null'
          description: Source of the card brand data.
          enum:
          - network
          - method
          - null
        shared:
          type: boolean
          description: Whether this card brand record is shared.
        network:
          type:
          - string
          - 'null'
          description: The card network. Deprecated in favor of brands[].network.
          enum:
          - visa
          - mastercard
          - amex
          - discover
          - null
        issuer:
          type:
          - string
          - 'null'
          description: The card issuer. Deprecated in favor of brands[].issuer.
        last4:
          type:
          - string
          - 'null'
          description: Last 4 digits of the card number. Deprecated in favor of brands[].
        status:
          type: string
          description: Current status of the card brand request.
          enum:
          - completed
          - pending
          - failed
        error:
          $ref: '#/components/schemas/ResourceError'
        created_at:
          type: string
          format: date-time
          description: Timestamp when the card brand was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the card brand was last updated.
    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.
    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'
    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.
    EntityExpandableConnect:
      title: EntityExpandableConnect
      description: Expandable. The entity connect session ID or expanded connect object.
      example: cxn_iENwGBMDnr7sJ
      oneOf:
      - type: string
        pattern: ^cxn_\w+$
      - type: 'null'
      - $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

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