# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Methodfi Entities API version: 1.0.0 extends: openapi/methodfi-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: 9 - target: $.paths['/entities'].get update: x-apievangelist-phrasing: intent: List entities effect: read questions: - Can I search my entities by name? - How do I list only entities with a given status or type? instructions: - text: List entities named {name}. slots: name: query.name - text: Show {status} entities of type {type}. slots: status: query.status type: query.type - text: List entities created from {from_date} to {to_date}. slots: from_date: query.from_date to_date: query.to_date method: generated generated: '2026-10-01' - target: $.paths['/entities'].post update: x-apievangelist-phrasing: intent: Create an entity effect: write questions: - How do I create a new individual or corporation in Method? - What's the first step to onboard a person before connecting their accounts? instructions: - text: Create a new entity under API version {version}. slots: version: header.Method-Version - text: Create an entity with idempotency key {key}. slots: key: header.Idempotency-Key method: generated generated: '2026-10-01' - target: $.paths['/entities/{entityId}'].get update: x-apievangelist-phrasing: intent: Get an entity with expanded details effect: read questions: - Can I fetch an entity and expand its related objects at the same time? - Which versioned call returns one entity by entityId? instructions: - text: Get entity {entity} with {expand} expanded. slots: entity: path.entityId expand: query.expand - text: Retrieve entity {entity} on API version {version}. slots: entity: path.entityId version: header.Method-Version method: generated generated: '2026-10-01' - target: $.paths['/entities/{entityId}'].put update: x-apievangelist-phrasing: intent: Update an entity (versioned) effect: write questions: - How do I change an entity's address on the current API version? - Can I add individual or corporation details to an existing entity? instructions: - text: Update the address of entity {entity} to {address} on the versioned endpoint. slots: entity: path.entityId address: requestBody.address - text: Add individual details {individual} to entity {entity}. slots: individual: requestBody.individual entity: path.entityId - text: Set corporation details {corporation} on entity {entity}. slots: corporation: requestBody.corporation entity: path.entityId method: generated generated: '2026-10-01' - target: $.paths['/entities/{ent_id}'].get update: x-apievangelist-phrasing: intent: Get an entity (legacy unversioned path) effect: read questions: - Is there an older entity lookup that takes ent_id without a version header? - Can I still read an entity via the legacy ent_id endpoint? instructions: - text: Look up entity {ent_id} on the legacy unversioned endpoint. slots: ent_id: path.ent_id - text: Fetch entity {ent_id} without a Method-Version header. slots: ent_id: path.ent_id method: generated generated: '2026-10-01' - target: $.paths['/entities/{ent_id}'].put update: x-apievangelist-phrasing: intent: Update an entity (legacy, type required) effect: write questions: - Does the legacy entity update require me to send the entity type? - Can I update an entity's metadata through the older ent_id path? instructions: - text: Update legacy entity {ent_id} of type {type} with metadata {metadata}. slots: ent_id: path.ent_id type: requestBody.type metadata: requestBody.metadata - text: On the unversioned path, change the address of entity {ent_id} of type {type} to {address}. slots: ent_id: path.ent_id type: requestBody.type address: requestBody.address method: generated generated: '2026-10-01' - target: $.paths['/entities/{ent_id}/credit_scores'].get update: x-apievangelist-phrasing: intent: Get an entity's credit scores (legacy) effect: read questions: - Can I read a person's credit scores from the legacy ent_id endpoint? - Where do I get the credit scores already pulled for an entity on the old path? instructions: - text: Get the credit scores for entity {ent_id} from the legacy endpoint. slots: ent_id: path.ent_id - text: Show credit scores on file for entity {ent_id}. slots: ent_id: path.ent_id method: generated generated: '2026-10-01' - target: $.paths['/entities/{ent_id}/verification_sessions'].get update: x-apievangelist-phrasing: intent: List an entity's verification sessions (legacy) effect: read questions: - Can I list identity verification sessions for an entity on the older ent_id path? - Which phone or KBA verifications has this entity gone through? instructions: - text: List verification sessions for entity {ent_id}. slots: ent_id: path.ent_id - text: Show past identity verification attempts for entity {ent_id} on the legacy path. slots: ent_id: path.ent_id method: generated generated: '2026-10-01' - target: $.paths['/entities/{ent_id}/verification_sessions'].post update: x-apievangelist-phrasing: intent: Start an SMS, KBA, SNA or BYO verification effect: write questions: - How do I start an SMS or KBA identity verification for an entity? - Which verification methods can a new entity session use on the legacy path? instructions: - text: Start a {type} verification for entity {ent_id} using method {method}. slots: type: requestBody.type ent_id: path.ent_id method: requestBody.method - text: Send an SMS verification to entity {ent_id} with settings {sms}. slots: ent_id: path.ent_id sms: requestBody.sms method: generated generated: '2026-10-01'