# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Identity API
  version: 1.0.0
extends: openapi/stripe-identity-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/v1/identity/verification_reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity verification reports
      effect: read
      questions:
      - How do I see the results of all identity checks I've run?
      - Can I list only document checks or only ID number checks?
      instructions:
      - text: List my identity verification reports.
      - text: List verification reports for session {verification_session}.
        slots:
          verification_session: query.verification_session
      - text: Show verification reports of type {type}.
        slots:
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/identity/verification_reports/{report}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an identity verification report
      effect: read
      questions:
      - How do I read the outcome of one identity verification?
      - Where do I see why a verification check failed?
      instructions:
      - text: Get verification report {report}.
        slots:
          report: path.report
      - text: Show me the results in identity report {report}.
        slots:
          report: path.report
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/identity/verification_sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity verification sessions
      effect: read
      questions:
      - How do I list all the identity verification sessions I've started?
      - Can I find sessions that are still waiting for the user to finish?
      instructions:
      - text: List my identity verification sessions.
      - text: List verification sessions with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/identity/verification_sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an identity verification
      effect: write
      questions:
      - How do I verify a user's identity with a photo ID?
      - Can I send users to a hosted verification page and bring them back after?
      - Which kinds of identity checks can I request?
      instructions:
      - text: Start an identity verification session of type {type}.
        slots:
          type: requestBody.type
      - text: Create a {type} verification that returns the user to {return_url}.
        slots:
          type: requestBody.type
          return_url: requestBody.return_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/identity/verification_sessions/{session}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an identity verification session
      effect: read
      questions:
      - How do I check where a user is in the identity verification process?
      - Can I look up an existing verification session to get its status and a fresh link?
      instructions:
      - text: Get verification session {session}.
        slots:
          session: path.session
      - text: Show the current status of identity session {session}.
        slots:
          session: path.session
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/identity/verification_sessions/{session}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an identity verification session
      effect: write
      questions:
      - How do I change the type of check on a verification that needs more input?
      - Can I update verification options after a session is created?
      instructions:
      - text: Change verification session {session} to type {type}.
        slots:
          session: path.session
          type: requestBody.type
      - text: Update the options on verification session {session} to {options}.
        slots:
          session: path.session
          options: requestBody.options
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/identity/verification_sessions/{session}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an identity verification
      effect: destructive
      questions:
      - How do I stop a user from completing an identity verification?
      - Can I undo cancelling a verification session?
      instructions:
      - text: Cancel verification session {session}.
        slots:
          session: path.session
      - text: Stop identity session {session} from accepting further submissions.
        slots:
          session: path.session
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/identity/verification_sessions/{session}/redact'].post
  update:
    x-apievangelist-phrasing:
      intent: Redact an identity verification's data
      effect: destructive
      questions:
      - How do I delete the personal data collected during an identity check?
      - Can I honor a user's request to erase their verification documents?
      instructions:
      - text: Redact verification session {session}.
        slots:
          session: path.session
      - text: Erase all collected identity data for session {session}.
        slots:
          session: path.session
      method: generated
      generated: '2026-09-26'