# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Method Entity Verification Sessions API
  version: 1.0.0
extends: openapi/methodfi-entity-verification-sessions-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: 4
- target: $.paths['/entities/{entityId}/verification_sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List verification sessions for an entity
      effect: read
      questions:
      - Which identity verifications has this entity gone through?
      - Can I list an entity's verification sessions in a date range?
      instructions:
      - text: List verification sessions for entity {entity}.
        slots:
          entity: path.entityId
      - text: Show verification sessions for entity {entity} from {from_date} to {to_date}.
        slots:
          entity: path.entityId
          from_date: query.from_date
          to_date: query.to_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/verification_sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an identity verification for an entity
      effect: write
      questions:
      - How do I verify a person's phone number by SMS?
      - Can I use my own KYC result to verify an entity?
      instructions:
      - text: Start a {type} verification for entity {entity} by {method}.
        slots:
          type: requestBody.type
          entity: path.entityId
          method: requestBody.method
      - text: Verify entity {entity} with my own KYC data {byo_kyc}, type {type}, method {method}.
        slots:
          entity: path.entityId
          byo_kyc: requestBody.byo_kyc
          type: requestBody.type
          method: requestBody.method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/verification_sessions/{evfId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one entity verification session
      effect: read
      questions:
      - Has a particular identity verification session passed?
      - Can I look up an entity verification session by its ID?
      instructions:
      - text: Get verification session {session} for entity {entity}.
        slots:
          session: path.evfId
          entity: path.entityId
      - text: Check whether verification {session} on entity {entity} succeeded.
        slots:
          session: path.evfId
          entity: path.entityId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/entities/{entityId}/verification_sessions/{evfId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Submit an SMS code or KBA answers
      effect: write
      questions:
      - How do I submit the SMS code a person received to finish verification?
      - Can I send knowledge-based answers to complete an identity check?
      instructions:
      - text: Submit SMS code {sms} to session {session} for entity {entity}, type {type}, method {method}.
        slots:
          sms: requestBody.sms
          session: path.evfId
          entity: path.entityId
          type: requestBody.type
          method: requestBody.method
      - text: Answer KBA questions {kba} on session {session} of entity {entity}, type {type}, method {method}.
        slots:
          kba: requestBody.kba
          session: path.evfId
          entity: path.entityId
          type: requestBody.type
          method: requestBody.method
      method: generated
      generated: '2026-10-01'