Uphold · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for KYC Connectors Veriff API

6 actions 6 updates phrasing extends openapi/uphold-veriff-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 6

$.info
$.paths['/kyc-connector/veriff/ingestions'].get
$.paths['/kyc-connector/veriff/ingestions'].post
$.paths['/kyc-connector/veriff/ingestions/{ingestionId}'].get
$.paths['/kyc-connector/veriff/config'].get
$.paths['/kyc-connector/veriff/config'].put

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 KYC Connectors Veriff API
  version: 1.0.0
extends: openapi/uphold-veriff-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: 5
- target: $.paths['/kyc-connector/veriff/ingestions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Veriff KYC imports
      effect: read
      questions:
      - Which Veriff verifications have been imported for this user?
      - How do I see past Veriff ingestions?
      instructions:
      - text: List my Veriff ingestions.
      - text: Show {perPage} Veriff ingestions per page.
        slots:
          perPage: query.perPage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kyc-connector/veriff/ingestions'].post
  update:
    x-apievangelist-phrasing:
      intent: Import KYC data from Veriff sessions
      effect: write
      questions:
      - How do I import a user's completed Veriff sessions as KYC?
      - Can I choose which KYC processes to ingest from Veriff?
      instructions:
      - text: Import Veriff sessions {sessions}.
        slots:
          sessions: requestBody.sessions
      - text: Ingest processes {processes} from Veriff sessions {sessions}.
        slots:
          processes: requestBody.processes
          sessions: requestBody.sessions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kyc-connector/veriff/ingestions/{ingestionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a Veriff KYC import
      effect: read
      questions:
      - How do I check whether a Veriff import finished?
      - What is the status of a specific Veriff ingestion?
      instructions:
      - text: Get Veriff ingestion {ingestionId}.
        slots:
          ingestionId: path.ingestionId
      - text: Check the status of Veriff import {ingestionId}.
        slots:
          ingestionId: path.ingestionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kyc-connector/veriff/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the organization's Veriff configuration
      effect: read
      questions:
      - How is Veriff configured for my organization?
      - Which Veriff integrations are currently set up?
      instructions:
      - text: Show our Veriff configuration.
      - text: Get the organization's Veriff integration settings.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kyc-connector/veriff/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Configure Veriff for the organization
      effect: write
      questions:
      - How do I connect my Veriff integrations to the KYC connector?
      - Can I replace the organization's Veriff integration list?
      instructions:
      - text: Set our Veriff configuration to integrations {integrations}.
        slots:
          integrations: requestBody.integrations
      - text: Configure Veriff with integrations {integrations}.
        slots:
          integrations: requestBody.integrations
      method: generated
      generated: '2026-09-26'