Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Identity Verification Step API

7 actions 7 updates phrasing extends openapi/strivacity-identity-verification-step-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Strivacity's API. It is a proposal applied on top of the contract, not a document Strivacity publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/admin/api/v1/identityProofings/{identityProofingId}/steps'].get

$.paths['/admin/api/v1/identityProofings/{identityProofingId}/steps'].put

$.paths['/admin/api/v1/identityProofings/{identityProofingId}/steps'].post

$.paths['/admin/api/v1/identityProofings/{identityProofingId}/steps/{id}'].get

$.paths['/admin/api/v1/identityProofings/{identityProofingId}/steps/{id}'].put

$.paths['/admin/api/v1/identityProofings/{identityProofingId}/steps/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin Portal Identity Verification Step API
  version: 1.0.0
extends: openapi/strivacity-identity-verification-step-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: 6
- target: $.paths['/admin/api/v1/identityProofings/{identityProofingId}/steps'].get
  update:
    x-apievangelist-phrasing:
      intent: List steps in an identity verification policy
      effect: read
      questions:
      - What steps does my identity verification policy run?
      - Can I list the verification steps for one policy?
      instructions:
      - text: List steps of identity verification policy {policy}.
        slots:
          policy: path.identityProofingId
      - text: Show the verification steps in policy {policy}.
        slots:
          policy: path.identityProofingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityProofings/{identityProofingId}/steps'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder identity verification steps
      effect: write
      questions:
      - How do I change the order in which verification steps run?
      - Can I move a verification step earlier in the flow?
      instructions:
      - text: Reorder the steps of identity verification policy {policy}.
        slots:
          policy: path.identityProofingId
      - text: Put the verification steps in policy {policy} in my new order.
        slots:
          policy: path.identityProofingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityProofings/{identityProofingId}/steps'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an identity verification step
      effect: write
      questions:
      - How do I add a new step to an identity verification policy?
      - Can a verification policy have multiple steps?
      instructions:
      - text: Add a step to identity verification policy {policy}.
        slots:
          policy: path.identityProofingId
      - text: Create a new verification step in policy {policy}.
        slots:
          policy: path.identityProofingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityProofings/{identityProofingId}/steps/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an identity verification step
      effect: read
      questions:
      - How is a specific verification step configured?
      - Can I fetch one step of an identity verification policy?
      instructions:
      - text: Get step {id} of identity verification policy {policy}.
        slots:
          id: path.id
          policy: path.identityProofingId
      - text: Show verification step {id} in policy {policy}.
        slots:
          id: path.id
          policy: path.identityProofingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityProofings/{identityProofingId}/steps/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an identity verification step
      effect: write
      questions:
      - How do I change the settings of a verification step?
      - Can I edit an existing identity verification step?
      instructions:
      - text: Update step {id} of identity verification policy {policy}.
        slots:
          id: path.id
          policy: path.identityProofingId
      - text: Change the configuration of verification step {id} in policy {policy}.
        slots:
          id: path.id
          policy: path.identityProofingId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityProofings/{identityProofingId}/steps/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an identity verification step
      effect: destructive
      questions:
      - How do I remove a step from my identity verification flow?
      - Can I delete a verification step I no longer need?
      instructions:
      - text: Delete step {id} from identity verification policy {policy}.
        slots:
          id: path.id
          policy: path.identityProofingId
      - text: Remove verification step {id} in policy {policy}.
        slots:
          id: path.id
          policy: path.identityProofingId
      method: generated
      generated: '2026-10-01'