Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Identity Verification API

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

$.info

$.paths['/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/accountProofings'].get

$.paths['/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/accountProofings'].post

$.paths['/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/accountProofings/{accountProofingId}'].delete

$.paths['/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/accountProofings/{accountProofingId}/invalidate'].post

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 API
  version: 1.0.0
extends: openapi/strivacity-identity-verification-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['/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/accountProofings'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's identity verifications
      effect: read
      questions:
      - Which identity verifications has a customer account gone through?
      - Can I see an account's identity proofing history?
      instructions:
      - text: List identity verifications for account {accountId} in {identityStoreName}.
        slots:
          accountId: path.accountId
          identityStoreName: path.identityStoreName
      - text: Show proofing records of {identityStoreName} account {accountId}.
        slots:
          accountId: path.accountId
          identityStoreName: path.identityStoreName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/accountProofings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an identity verification
      effect: write
      questions:
      - How do I start an identity verification for a customer account?
      - Which identity verification policy is used when I create a verification?
      instructions:
      - text: Create an identity verification for account {accountId} in {identityStoreName} using policy {policyId}.
        slots:
          accountId: path.accountId
          identityStoreName: path.identityStoreName
          policyId: requestBody.policyId
      - text: Verify {identityStoreName} account {accountId} under policy {policyId}.
        slots:
          identityStoreName: path.identityStoreName
          accountId: path.accountId
          policyId: requestBody.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/accountProofings/{accountProofingId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear attempts on an identity verification
      effect: destructive
      questions:
      - Can I clear failed attempts so a customer can retry identity verification?
      - How do I reset the attempt count on an identity verification?
      instructions:
      - text: Delete the attempts for verification {accountProofingId} on account {accountId} in {identityStoreName}.
        slots:
          accountProofingId: path.accountProofingId
          accountId: path.accountId
          identityStoreName: path.identityStoreName
      - text: Clear failed proofing attempts {accountProofingId} for {identityStoreName} account {accountId}.
        slots:
          accountProofingId: path.accountProofingId
          identityStoreName: path.identityStoreName
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/accountProofings/{accountProofingId}/invalidate'].post
  update:
    x-apievangelist-phrasing:
      intent: Invalidate an identity verification
      effect: destructive
      questions:
      - How do I mark a completed identity verification as no longer valid?
      - Can I invalidate a customer's identity proofing?
      instructions:
      - text: Invalidate verification {accountProofingId} for account {accountId} in {identityStoreName}.
        slots:
          accountProofingId: path.accountProofingId
          accountId: path.accountId
          identityStoreName: path.identityStoreName
      - text: Revoke {identityStoreName} account {accountId}'s identity proofing {accountProofingId}.
        slots:
          identityStoreName: path.identityStoreName
          accountId: path.accountId
          accountProofingId: path.accountProofingId
      method: generated
      generated: '2026-10-01'