Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Identity Verification API

2 actions 2 updates phrasing extends openapi/impact-identity-verification-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Impact's API. It is a proposal applied on top of the contract, not a document Impact publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/Mediapartners/{AccountSID}/IdentityVerification/Session'].post

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 Partner Identity Verification API
  version: 1.0.0
extends: openapi/impact-identity-verification-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: 1
- target: $.paths['/Mediapartners/{AccountSID}/IdentityVerification/Session'].post
  update:
    x-apievangelist-phrasing:
      intent: Start or resume identity verification
      effect: write
      questions:
      - How do I launch identity verification for a partner user?
      - What happens if a verification session is already in progress?
      instructions:
      - text: Start an identity verification session for user {user} on account {sid}.
        slots:
          sid: path.AccountSID
          user: requestBody.UserId
      - text: Resume verification for user {user} and call back to {callback}.
        slots:
          user: requestBody.UserId
          callback: requestBody.CallbackUrl
      method: generated
      generated: '2026-09-26'