Generated by API Evangelist
Written by API Evangelist tooling for Method Financial's API. It is a proposal applied on top of the contract, not a document Method Financial publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Method Simulate Entities API
version: 1.0.0
extends: openapi/methodfi-simulate-entities-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/simulate/entities/{entity_id}/credit_scores/{crs_id}'].post
update:
x-apievangelist-phrasing:
intent: Simulate a credit score in sandbox
effect: write
questions:
- Can I set a specific credit score for a test entity?
- Is there a way to simulate a credit score result during development?
instructions:
- text: Simulate a score of {score} for credit score {crs} on entity {entity}.
slots:
score: requestBody.score
crs: path.crs_id
entity: path.entity_id
- text: Set sandbox credit score {crs} of entity {entity} to {score} with status {status}.
slots:
crs: path.crs_id
entity: path.entity_id
score: requestBody.score
status: requestBody.status
method: generated
generated: '2026-10-01'
- target: $.paths['/simulate/entities/{entity_id}/connect'].post
update:
x-apievangelist-phrasing:
intent: Simulate entity connect in sandbox
effect: write
questions:
- Where do I test account discovery for an entity in sandbox?
- Can I simulate the connect flow without real institutions?
instructions:
- text: Simulate a connect for sandbox entity {entity}.
slots:
entity: path.entity_id
- text: Run a test account discovery for entity {entity}.
slots:
entity: path.entity_id
method: generated
generated: '2026-10-01'
- target: $.paths['/simulate/entities/{entity_id}/attributes'].post
update:
x-apievangelist-phrasing:
intent: Simulate entity attributes in sandbox
effect: write
questions:
- Can I generate fake attribute data for a test entity?
- How do I test attribute retrieval during development?
instructions:
- text: Simulate attributes for sandbox entity {entity}.
slots:
entity: path.entity_id
- text: Create test attribute data for entity {entity}.
slots:
entity: path.entity_id
method: generated
generated: '2026-10-01'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.