How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MethodFi Simulate Entities API

Sandbox entity simulation

MethodFi Simulate Entities API is one of 44 APIs that MethodFi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Simulate Entities. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 2025-12-01.

Requests are made against 3 base URLs: https://production.methodfi.com, https://sandbox.methodfi.com, https://dev.methodfi.com.

3 operations 3 paths 44 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2025-12-01
Base URL
https://production.methodfi.com
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

MethodFi Simulate Entities API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpalToken). It accepts HTTP bearer tokens (SecretKey). By default, every request must be authenticated.

  • OpalToken — Opal token authentication for Opal session endpoints. Use an Opal token (otkn...) as the Bearer token. Created via POST /opal/token using a secret key.
  • SecretKey — Secret key authentication. Use your team's secret key (sk...) as the Bearer token. All authenticated API endpoints require this scheme unless otherwise noted.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Simulate Entities 3

Sandbox entity simulation

POST
/simulate/entities/{entity_id}/credit_scores/{crs_id}
Simulate a credit score
simulateEntityCreditScore 3 params body → 200400401404500
POST
/simulate/entities/{entity_id}/connect
Simulate entity connect
simulateEntityConnect 2 params → 200400401404500
POST
/simulate/entities/{entity_id}/attributes
Simulate entity attributes
simulateEntityAttributes 2 params → 200400401404500

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are Account (26 properties), AccountUpdate (17 properties), AccountVerificationSession (17 properties), AccountCardBrand (12 properties). Each schema is shown below with its type and property counts.

AccountDebitCard
objectnull
Debit card account details. Present when type is debitcard.
3 properties
ErrorEnvelope
object
3 properties 3 required
ResourceError
objectnull
4 properties 3 required
AccountExpandableUpdate
The latest update ID. This field is expandable. When expanded, returns the full AccountUpdate object.
EntityAttributeData
objectnull
Financial health and credit attribute data.
9 properties
AccountAttribute
object
An attribute record for an account containing financial data attributes.
7 properties 6 required
MerchantType
string
EntityAttributeResponse
AccountExpandableCardBrand
The latest card brand ID. This field is expandable. When expanded, returns the full AccountCardBrand object.
AccountClearing
objectnull
Clearing account details. Present when type is clearing.
3 properties
CreditScoreResourceError
objectnull
Error details when a credit score pull fails.
4 properties 4 required
AccountPaymentInstrument
object
A payment instrument for an account.
11 properties 6 required
AccountSensitive
object
Sensitive data for an account.
8 properties 7 required
AccountLiability
objectnull
Liability account details. Present when type is liability.
7 properties 7 required
AccountCardBrand
object
Card brand information for an account.
12 properties 5 required
AccountSensitiveResourceError
objectnull
Error details when retrieving account sensitive data fails.
4 properties 4 required
AccountExpandableSensitive
The latest sensitive ID. This field is expandable. When expanded, returns the full AccountSensitive object.
AccountVerificationSessionResourceError
objectnull
Error details when an account verification session fails.
4 properties 4 required
BalanceResourceError
objectnull
Error details when a balance sync fails.
4 properties 4 required
Merchant
object
8 properties 8 required
EntityConnect
object
9 properties 8 required
AccountUpdate
object
An update record for an account.
17 properties 6 required
AccountVerificationSession
object
A verification session for an account.
17 properties 6 required
AccountExpandableAttribute
The latest attribute ID. This field is expandable. When expanded, returns the full AccountAttribute object.
ConnectResourceError
objectnull
Error details when a connect session fails.
4 properties 4 required
EntityConnectResponse
AccountExpandablePaymentInstrument
The latest payment instrument ID. This field is expandable. When expanded, returns the full AccountPaymentInstrument object.
AccountExpandableBalance
The latest balance ID. This field is expandable. When expanded, returns the full AccountBalance object.
Account
object
An Account represents a financial account (ACH, liability, clearing, or debit card) associated with an Entity. The type field indicates which nested details ob…
26 properties 9 required
AccountACH
objectnull
ACH account details. Present when type is ach.
3 properties
AccountExpandablePayoff
The latest payoff ID. This field is expandable. When expanded, returns the full AccountPayoff object.
SuccessEnvelope
object
Standard envelope for successful responses that return a single payload.
3 properties 3 required
Metadata
objectnull
Arbitrary key-value metadata attached to the resource.
PayoffResourceError
objectnull
Error details when a payoff sync fails.
4 properties 4 required
AccountBalance
object
A balance record for an account.
7 properties 6 required
MerchantProviderIds
object
5 properties
AccountResourceError
objectnull
Error details when an account is disabled.
4 properties 4 required
EntityCreditScoreResponse
EntityCreditScoreFactor
object
2 properties
EntityAttribute
object
7 properties 6 required
UpdateResourceError
objectnull
Error details when an account update fails.
4 properties 4 required
EntityCreditScore
object
7 properties 6 required
AccountPayoff
object
A payoff record for an account.
9 properties 8 required
ErrorObject
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

methodfi-simulate-entities-api-openapi.yml Raw ↑

Other APIs MethodFi publishes across the network.

MethodFi Account Attributes API
MethodFi Account Balances API
MethodFi Account Card Brands API
MethodFi Account Consent API
MethodFi Account Payment Instruments API
MethodFi Account Payoffs API
MethodFi Account Products API
MethodFi Account Sensitive API
MethodFi Account Subscriptions API
MethodFi Account Transactions API
MethodFi Account Updates API
MethodFi Account Verification Sessions API
Where this information came from

This is an independent, third-party profile of MethodFi Simulate Entities API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.