Uphold · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Topper KYC sharing API

3 actions 3 updates phrasing extends openapi/uphold-kyc-sharing-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Uphold's API. It is a proposal applied on top of the contract, not a document Uphold publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/topper/kyc-sharing/identify-user'].post
$.paths['/topper/kyc-sharing/sessions'].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 Topper KYC sharing API
  version: 1.0.0
extends: openapi/uphold-kyc-sharing-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: 2
- target: $.paths['/topper/kyc-sharing/identify-user'].post
  update:
    x-apievangelist-phrasing:
      intent: Identify a user for KYC sharing
      effect: read
      questions:
      - How do I check whether a user can reuse existing KYC via sharing?
      - Can I identify a KYC-sharing user by email and country?
      instructions:
      - text: Identify the KYC sharing user {email} in {country}.
        slots:
          email: requestBody.email
          country: requestBody.country
      - text: Look up {email} from {country} for KYC sharing.
        slots:
          email: requestBody.email
          country: requestBody.country
      method: generated
      generated: '2026-09-26'
- target: $.paths['/topper/kyc-sharing/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a KYC sharing session
      effect: write
      questions:
      - How do I start a session so a user can share their KYC data?
      - What do I need to open a KYC sharing session?
      instructions:
      - text: Create a KYC sharing session for user {userId}.
        slots:
          userId: requestBody.userId
      - text: Open a KYC sharing session for {userId}.
        slots:
          userId: requestBody.userId
      method: generated
      generated: '2026-09-26'