Method Financial Entity Consent API
Consent management for entities
Consent management for entities
openapi: 3.2.0
info:
title: Method Entity Consent 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 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:
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
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.
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'
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.
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.
Address:
type: object
description: Postal mailing address.
properties:
line1:
type:
- string
- 'null'
description: Primary street address line.
example: 123 Main St
line2:
type:
- string
- 'null'
description: Secondary address line such as apartment or suite.
example: Apt 4B
city:
type:
- string
- 'null'
description: City or locality.
example: Austin
state:
type:
- string
- 'null'
description: Two-letter state or province code when available.
example: TX
zip:
type:
- string
- 'null'
description: Postal code.
example: '78701'
example:
line1: 123 Main St
line2: Apt 4B
city: Austin
state: TX
zip: '78701'
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
EntityBase:
type: object
required:
- id
- type
- status
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier for the entity.
pattern: ^ent_\w+$
example: ent_au22b1fbFJbp8
type:
type: string
description: The type of entity.
enum:
- individual
- c_corporation
- s_corporation
- llc
- partnership
- sole_proprietorship
- corporation
address:
type:
- object
- 'null'
description: The entity's address.
allOf:
- $ref: '#/components/schemas/Address'
status:
type: string
description: Current status of the entity.
enum:
- active
- incomplete
- disabled
error:
type:
- object
- 'null'
description: Error details if the entity encountered an error.
allOf:
- $ref: '#/components/schemas/EntityResourceError'
metadata:
$ref: '#/components/schemas/Metadata'
created_at:
type: string
format: date-time
description: Timestamp when the entity was created.
updated_at:
type: string
format: date-time
description: Timestamp when the entity was last updated.
EntityAttribute:
type: object
required:
- id
- entity_id
- status
- attributes
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier for the entity attribute.
example: attr_QwMjMDEwMTY1
entity_id:
type: string
description: The ID of the entity this attribute belongs to.
example: ent_au22b1fbFJbp8
status:
type: string
description: Status of the attribute retrieval.
enum:
- completed
- in_progress
- pending
- failed
attributes:
$ref: '#/components/schemas/EntityAttributeData'
error:
type:
- object
- 'null'
description: Error details if the resource encountered an error.
allOf:
- $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.
ResourceError:
type:
- object
- 'null'
required:
- type
- code
- message
properties:
type:
type: string
code:
type: integer
sub_type:
type:
- string
- 'null'
message:
type: string
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'
EntityIndividual:
type:
- object
- 'null'
properties:
first_name:
type:
- string
- 'null'
description: First name of the individual.
last_name:
type:
- string
- 'null'
description: Last name of the individual.
phone:
type:
- string
- 'null'
description: Phone number of the individual.
pattern: ^\+\d{10,15}$
example: '+15121231111'
email:
type:
- string
- 'null'
description: Email address of the individual.
format: email
dob:
type:
- string
- 'null'
format: date
description: Date of birth of the individual (YYYY-MM-DD).
ssn:
type:
- string
- 'null'
description: Social security number (masked).
ssn_4:
type:
- string
- 'null'
description: Last 4 digits of SSN (masked).
EntityExpandableVehicle:
title: EntityExpandableVehicle
description: Expandable. The entity vehicle ID or expanded vehicle object.
example: vhl_JMDEwMTY1Qw4c
oneOf:
- type: string
pattern: ^vhl_\w+$
- type: 'null'
- $ref: '#/components/schemas/EntityVehicle'
Entity:
description: An Entity represents an individual or business profile within Method.
oneOf:
- $ref: '#/components/schemas/EntityIndividualResource'
- $ref: '#/components/schemas/EntityCorporationResource'
discriminator:
propertyName: type
mapping:
individual: '#/components/schemas/EntityIndividualResource'
corporation: '#/components/schemas/EntityCorporationResource'
c_corporation: '#/components/schemas/EntityCorporationResource'
s_corporation: '#/components/schemas/EntityCorporationResource'
llc: '#/components/schemas/EntityCorporationResource'
partnership: '#/components/schemas/EntityCorporationResource'
sole_proprietorship: '#/components/schemas/EntityCorporationResource'
UpdateEntityConsentRequest:
type: object
required:
- type
properties:
type:
type: string
description: The consent action type.
enum:
- grant
- withdraw
reason:
type: string
description: Optional reason for the consent action.
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.
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.
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'
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
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.
EntityVerification:
type:
- object
- 'null'
properties:
identity:
$ref: '#/components/schemas/EntityVerificationIdentity'
phone:
$ref: '#/components/schemas/EntityVerificationPhone'
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'
EntityVerificationPhone:
type: object
properties:
verified:
type: boolean
description: Whether the phone has been verified.
latest_verification_session:
title: EntityPhoneExpandableLatestVerificationSession
description: ID of the latest phone verification session. Expandable via `phone_latest_verification_session`.
oneOf:
- type: string
pattern: ^evf_\w+$
- type: 'null'
- $ref: '#/components/schemas/EntityVerificationSession'
methods:
type: array
items:
type: string
description: Available phone verification methods.
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 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.
JsonObject:
type: object
description: Arbitrary JSON object.
additionalProperties: true
EntityVerificationIdentity:
type: object
properties:
verified:
type: boolean
description: Whether the identity has been verified.
matched:
type: boolean
description: Whether the identity information matched.
latest_verification_session:
title: EntityIdentityExpandableLatestVerificationSession
description: ID of the latest identity verification session. Expandable via `identity_latest_verification_session`.
oneOf:
- type: string
pattern: ^evf_\w+$
- type: 'null'
- $ref: '#/components/schemas/EntityVerificationSession'
methods:
type: array
items:
type: string
description: Available identity verification methods.
AccountACH:
type:
- object
- 'null'
description: ACH account details. Present when `type` is `ach`.
properties:
routing:
type: string
description: The ACH routing number.
number:
type: string
description: The ACH account number.
type:
type: string
description: The type of ACH account.
enum:
- checking
# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/method-financial/refs/heads/main/openapi/method-financial-entity-consent-api-openapi.yml