Method Financial Entities API
Individuals, corporations, and receive-only entities
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/method-financial-entities-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Method Entities 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: Entities
description: Individuals, corporations, and receive-only entities
paths:
/entities:
get:
operationId: listEntities
summary: List all entities
description: Returns a paginated list of entities.
tags:
- Entities
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/PageLimitParam'
- $ref: '#/components/parameters/PageCursorParam'
- $ref: '#/components/parameters/FromDateParam'
- $ref: '#/components/parameters/ToDateParam'
- name: status
in: query
required: false
description: Filter entities by status.
schema:
type: string
enum:
- active
- incomplete
- disabled
- name: type
in: query
required: false
description: Filter entities by type.
schema:
type: string
enum:
- individual
- corporation
- name: name
in: query
required: false
description: Filter entities by their name.
schema:
type: string
- $ref: '#/components/parameters/expand_entities'
responses:
'200':
description: A list of entities.
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/EntityListResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
post:
operationId: createEntity
summary: Create an entity
description: Creates a new entity.
tags:
- Entities
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- $ref: '#/components/parameters/idempotency_key'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEntityRequest'
examples:
individual:
summary: Create an individual entity
value:
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'
metadata:
customer_reference: ent-001
corporation:
summary: Create a corporation entity
value:
type: corporation
corporation:
name: Example Holdings LLC
dba: Example Holdings
ein: '123456789'
address:
line1: 123 Main St
line2: null
city: Austin
state: TX
zip: '78701'
responses:
'200':
description: The created entity.
content:
application/json:
schema:
$ref: '#/components/schemas/EntityResponse'
examples:
individual:
summary: Individual entity
value:
success: true
data:
id: ent_au22b1fbFJbp8
type: individual
individual:
first_name: Jane
last_name: Doe
phone: '+15125550123'
dob: '1990-05-21'
email: jane@example.com
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
corporation:
summary: Corporation entity
value:
success: true
data:
id: ent_bWxYzAbCdEfGh
type: corporation
corporation:
name: Example Holdings LLC
dba: Example Holdings
ein: '123456789'
owners: []
address:
line1: 123 Main St
line2: null
city: Austin
state: TX
zip: '78701'
status: active
error: null
metadata: null
created_at: '2024-12-03T17:08:05.455Z'
updated_at: '2024-12-03T17:08:05.455Z'
message: null
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
/entities/{entityId}:
get:
operationId: retrieveEntity
summary: Retrieve an entity
description: Returns a single entity by its identifier.
tags:
- Entities
security:
- SecretKey: []
parameters:
- $ref: '#/components/parameters/method_version'
- $ref: '#/components/parameters/EntityIdParam'
- $ref: '#/components/parameters/expand_entities'
responses:
'200':
description: The requested 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'
'429':
$ref: '#/components/responses/RateLimited'
'500':
$ref: '#/components/responses/InternalError'
put:
operationId: updateEntity
summary: Update an entity
description: Updates an existing entity.
tags:
- Entities
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/UpdateEntityRequest'
examples:
individual:
summary: Update an individual entity
value:
individual:
phone: '+15125550124'
email: jane.doe@example.com
metadata:
crm_status: verified
corporation:
summary: Update a corporation entity
value:
corporation:
dba: Example Finance
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:
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.
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'
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.
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.
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.
AccountUpdate:
type: object
description: An update record for an account.
required:
- id
- account_id
- status
- type
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier for the update.
pattern: ^upd_\w+$
example: upd_aTJMbnCjw34yQ
account_id:
type: string
description: The account this update belongs to.
pattern: ^acc_\w+$
status:
type: string
description: Current status of the update.
enum:
- completed
- pending
- failed
type:
type: string
description: The liability type of the account being updated.
enum:
- credit_card
- auto_loan
- mortgage
- personal_loan
- student_loan
- student_loans
- collection
- credit_builder
- insurance
- loan
- medical
- utility
- bnpl
- fintech
source:
type: string
description: The data source used for this update.
enum:
- direct
- snapshot
data_as_of:
type:
- string
- 'null'
format: date-time
description: The timestamp of the data used to complete this update.
credit_card:
type:
- object
- 'null'
description: Credit card update data. Present when `type` is `credit_card`.
properties:
sub_type:
type:
- string
- 'null'
opened_at:
type:
- string
- 'null'
format: date
closed_at:
type:
- string
- 'null'
format: date
balance:
type:
- integer
- 'null'
description: Current balance in cents.
last_payment_amount:
type:
- integer
- 'null'
description: Last payment amount in cents.
last_payment_date:
type:
- string
- 'null'
format: date
next_payment_due_date:
type:
- string
- 'null'
format: date
next_payment_minimum_amount:
type:
- integer
- 'null'
description: Minimum payment due in cents.
interest_rate_type:
type:
- string
- 'null'
interest_rate_percentage_max:
type:
- number
- 'null'
interest_rate_percentage_min:
type:
- number
- 'null'
available_credit:
type:
- integer
- 'null'
description: Available credit in cents.
credit_limit:
type:
- integer
- 'null'
description: Credit limit in cents.
usage_pattern:
type:
- string
- 'null'
auto_loan:
type:
- object
- 'null'
description: Auto loan update data. Present when `type` is `auto_loan`.
properties:
sub_type:
type:
- string
- 'null'
opened_at:
type:
- string
- 'null'
format: date
closed_at:
type:
- string
- 'null'
format: date
balance:
type:
- integer
- 'null'
description: Current balance in cents.
last_payment_amount:
type:
- integer
- 'null'
description: Last payment amount in cents.
last_payment_date:
type:
- string
- 'null'
format: date
next_payment_due_date:
type:
- string
- 'null'
format: date
next_payment_minimum_amount:
type:
- integer
- 'null'
description: Minimum payment due in cents.
interest_rate_type:
type:
- string
- 'null'
expected_payoff_date:
type:
- string
- 'null'
format: date
original_loan_amount:
type:
- integer
- 'null'
description: Original loan amount in cents.
term_length:
type:
- integer
- 'null'
interest_rate_percentage:
type:
- number
- 'null'
interest_rate_source:
type:
- string
- 'null'
mortgage:
type:
- object
- 'null'
description: Mortgage update data. Present when `type` is `mortgage`.
properties:
sub_type:
type:
- string
- 'null'
opened_at:
type:
- string
- 'null'
format: date
closed_at:
type:
- string
- 'null'
format: date
balance:
type:
- integer
- 'null'
description: Current balance in cents.
last_payment_amount:
type:
- integer
- 'null'
description: Last payment amount in cents.
last_payment_date:
type:
- string
- 'null'
format: date
next_payment_due_date:
type:
- string
- 'null'
format: date
next_payment_minimum_amount:
type:
- integer
- 'null'
description: Minimum payment due in cents.
interest_rate_type:
type:
- string
- 'null'
expected_payoff_date:
type:
- string
- 'null'
format: date
original_loan_amount:
type:
- integer
- 'null'
description: Original loan amount in cents.
term_length:
type:
- integer
- 'null'
interest_rate_percentage:
type:
- number
- 'null'
interest_rate_source:
type:
- string
- 'null'
personal_loan:
type:
- object
- 'null'
description: Personal loan update data. Present when `type` is `personal_loan`.
properties:
sub_type:
type:
- string
- 'null'
opened_at:
type:
- string
- 'null'
format: date
closed_at:
type:
- string
- 'null'
format: date
balance:
type:
- integer
- 'null'
description: Current balance in cents.
last_payment_amount:
type:
- integer
- 'null'
description: Last payment amount in cents.
last_payment_date:
type:
- string
- 'null'
format: date
next_payment_due_date:
type:
- string
- 'null'
format: date
next_payment_minimum_amount:
type:
- integer
- 'null'
description: Minimum payment due in cents.
interest_rate_type:
type:
- string
- 'null'
available_credit:
type:
- integer
- 'null'
description: Available credit in cents.
original_loan_amount:
type:
- integer
- 'null'
description: Original loan amount in cents.
term_length:
type:
- integer
- 'null'
interest_rate_percentage:
type:
- number
- 'null'
interest_rate_source:
type:
- string
- 'null'
student_loan:
type:
- object
- 'null'
description: Student loan update data. Present when `type` is `student_loan`.
properties:
sub_type:
type:
- string
- 'null'
opened_at:
type:
- string
- 'null'
format: date
closed_at:
type:
- string
- 'null'
format: date
balance:
type:
- integer
- 'null'
description: Current balance in cents.
last_payment_amount:
type:
- integer
- 'null'
description: Last payment amount in cents.
last_payment_date:
type:
- string
- 'null'
format: date
next_payment_due_date:
type:
- string
- 'null'
format: date
next_payment_minimum_amount:
type:
- integer
- 'null'
description: Minimum payment due in cents.
interest_rate_type:
type:
- string
- 'null'
expected_payoff_date:
type:
- string
- 'null'
format: date
original_loan_amount:
type:
- integer
- 'null'
description: Original loan amount in cents.
term_length:
type:
- integer
- 'null'
interest_rate_percentage:
type:
- number
- 'null'
interest_rate_source:
type:
- string
- 'null'
student_loans:
type:
- object
- 'null'
description: Student loans aggregate update data. Present when `type` is `student_loans`.
properties:
sub_type:
type:
- string
- 'null'
opened_at:
type:
- string
- 'null'
format: date
closed_at:
type:
- string
- 'null'
format: date
balance:
type:
- integer
- 'null'
description: Current balance in cents.
last_payment_amount:
type:
- integer
- 'null'
description: Last payment amount in cents.
last_payment_date:
type:
- string
- 'null'
format: date
next_payment_due_date:
type:
- string
- 'null'
format: date
next_payment_minimum_amount:
type:
- integer
- 'null'
description: Minimum payment due in cents.
interest_rate_type:
type:
- string
- 'null'
disbursements:
type:
- array
- 'null'
items:
type: object
original_loan_amount:
type:
- integer
- 'null'
# --- truncated at 32 KB (115 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/method-financial/refs/heads/main/openapi/method-financial-entities-api-openapi.yml