Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Identity Verification Policy API

6 actions 6 updates phrasing extends openapi/strivacity-identity-verification-policy-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 6

$.info
$.paths['/admin/api/v1/identityProofings'].get
$.paths['/admin/api/v1/identityProofings'].post
$.paths['/admin/api/v1/identityProofings/{id}'].get
$.paths['/admin/api/v1/identityProofings/{id}'].put
$.paths['/admin/api/v1/identityProofings/{id}'].delete

OpenAPI Overlay

Raw ↑
# 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 Policy API
  version: 1.0.0
extends: openapi/strivacity-identity-verification-policy-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: 5
- target: $.paths['/admin/api/v1/identityProofings'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity verification policies
      effect: read
      questions:
      - Which identity verification policies have we set up?
      - Can I filter identity proofing policies by name or tag?
      instructions:
      - text: List identity verification policies.
      - text: Find identity verification policies named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityProofings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an identity verification policy
      effect: write
      questions:
      - How do I set up identity proofing for new customers?
      - What failure message does an identity verification policy need?
      instructions:
      - text: Create identity verification policy {name} with failure message {message}.
        slots:
          name: requestBody.name
          message: requestBody.failureMessage
      - text: Set up a new identity proofing policy named {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityProofings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an identity verification policy
      effect: read
      questions:
      - How is a particular identity verification policy configured?
      - Can I view one identity proofing policy by ID?
      instructions:
      - text: Get identity verification policy {id}.
        slots:
          id: path.id
      - text: Show identity proofing policy {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityProofings/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an identity verification policy
      effect: write
      questions:
      - How do I change the failure message of an identity verification policy?
      - Can I rename an identity proofing policy?
      instructions:
      - text: Update identity verification policy {id} failure message to {message}.
        slots:
          id: path.id
          message: requestBody.failureMessage
      - text: Rename identity proofing policy {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityProofings/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an identity verification policy
      effect: destructive
      questions:
      - How do I remove an identity verification policy?
      - Why can't I delete a verification policy assigned to an application?
      instructions:
      - text: Delete identity verification policy {id}.
        slots:
          id: path.id
      - text: Remove identity proofing policy {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'