Uphold · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for KYC Connectors Sumsub API

4 actions 4 updates phrasing extends openapi/uphold-sumsub-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 4

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

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 Sumsub API
  version: 1.0.0
extends: openapi/uphold-sumsub-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: 3
- target: $.paths['/kyc-connector/sumsub/ingestions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Sumsub KYC imports
      effect: read
      questions:
      - Which Sumsub verifications have been imported for this user?
      - How do I see past Sumsub ingestions?
      instructions:
      - text: List my Sumsub ingestions.
      - text: Show {perPage} Sumsub ingestions per page.
        slots:
          perPage: query.perPage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kyc-connector/sumsub/ingestions'].post
  update:
    x-apievangelist-phrasing:
      intent: Import KYC data from Sumsub
      effect: write
      questions:
      - How do I import a user's existing Sumsub verification?
      - Can I reuse Sumsub KYC with a share token?
      instructions:
      - text: Import Sumsub KYC using share token {shareToken}.
        slots:
          shareToken: requestBody.shareToken
      - text: Ingest processes {processes} from Sumsub with token {shareToken}.
        slots:
          processes: requestBody.processes
          shareToken: requestBody.shareToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/kyc-connector/sumsub/ingestions/{ingestionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a Sumsub KYC import
      effect: read
      questions:
      - How do I check whether a Sumsub import finished?
      - What is the status of a specific Sumsub ingestion?
      instructions:
      - text: Get Sumsub ingestion {ingestionId}.
        slots:
          ingestionId: path.ingestionId
      - text: Check the status of Sumsub import {ingestionId}.
        slots:
          ingestionId: path.ingestionId
      method: generated
      generated: '2026-09-26'