# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Uphold KYC API
  version: 1.0.0
extends: openapi/uphold-kyc-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: 13
- target: $.paths['/core/kyc'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's KYC status overview
      effect: read
      questions:
      - Where does this user stand in identity verification?
      - Which KYC steps are still outstanding for a user?
      - Can I get detailed results for specific KYC processes?
      instructions:
      - text: Show my KYC overview.
      - text: Get the KYC overview with details for {detailed}.
        slots:
          detailed: query.detailed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/kyc/processes/profile'].patch
  update:
    x-apievangelist-phrasing:
      intent: Submit a user's KYC profile details
      effect: write
      questions:
      - How do I submit a user's name and birth date for KYC?
      - Can I update the profile step of verification?
      instructions:
      - text: Submit KYC profile details {input}.
        slots:
          input: requestBody.input
      - text: Update my verification profile with {input}.
        slots:
          input: requestBody.input
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/kyc/processes/address'].patch
  update:
    x-apievangelist-phrasing:
      intent: Submit a user's residential address for KYC
      effect: write
      questions:
      - How do I provide a user's home address for verification?
      - Can I change the residential address submitted for KYC?
      instructions:
      - text: Submit residential address {input} for KYC.
        slots:
          input: requestBody.input
      - text: Update my KYC home address to {input}.
        slots:
          input: requestBody.input
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/kyc/processes/email'].patch
  update:
    x-apievangelist-phrasing:
      intent: Submit a user's email for KYC
      effect: write
      questions:
      - How do I verify a user's email address as part of onboarding?
      - Can I update the email used in the KYC process?
      instructions:
      - text: Submit email {input} for KYC verification.
        slots:
          input: requestBody.input
      - text: Update the KYC email step with {input}.
        slots:
          input: requestBody.input
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/kyc/processes/phone'].patch
  update:
    x-apievangelist-phrasing:
      intent: Submit a user's phone number for KYC
      effect: write
      questions:
      - How do I add a phone number to a user's verification?
      - Can I update the phone step of KYC?
      instructions:
      - text: Submit phone number {input} for KYC.
        slots:
          input: requestBody.input
      - text: Update my KYC phone verification with {input}.
        slots:
          input: requestBody.input
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/kyc/processes/identity'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the identity verification step
      effect: write
      questions:
      - How do I move a user's identity document check forward?
      - Can I update the identity process in KYC?
      instructions:
      - text: Update my KYC identity verification step.
      - text: Refresh the identity document check for this user.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/kyc/processes/proof-of-address'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the proof-of-address step
      effect: write
      questions:
      - How do I progress a user's proof-of-address check?
      - Can I update the proof-of-address process after uploading a document?
      instructions:
      - text: Update my KYC proof-of-address step.
      - text: Advance the proof-of-address check for this user.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/kyc/processes/customer-due-diligence'].patch
  update:
    x-apievangelist-phrasing:
      intent: Submit customer due diligence answers
      effect: write
      questions:
      - How do I submit customer due diligence answers like source of funds?
      - Can I update a user's CDD questionnaire?
      instructions:
      - text: Submit customer due diligence answers {input}.
        slots:
          input: requestBody.input
      - text: Update my CDD questionnaire with {input}.
        slots:
          input: requestBody.input
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/kyc/processes/enhanced-due-diligence'].patch
  update:
    x-apievangelist-phrasing:
      intent: Submit enhanced due diligence answers
      effect: write
      questions:
      - How do I submit enhanced due diligence for a higher-risk user?
      - Can I update a user's EDD information?
      instructions:
      - text: Submit enhanced due diligence answers {input}.
        slots:
          input: requestBody.input
      - text: Update my EDD details with {input}.
        slots:
          input: requestBody.input
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/kyc/processes/crypto-risk-assessment'].patch
  update:
    x-apievangelist-phrasing:
      intent: Submit a crypto risk assessment
      effect: write
      questions:
      - How do I complete the crypto risk assessment for a user?
      - Can I update a user's answers to the crypto risk questionnaire?
      instructions:
      - text: Submit crypto risk assessment answers {input}.
        slots:
          input: requestBody.input
      - text: Update my crypto risk assessment with {input}.
        slots:
          input: requestBody.input
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/kyc/processes/self-categorization-statement'].patch
  update:
    x-apievangelist-phrasing:
      intent: Submit an investor self-categorization statement
      effect: write
      questions:
      - How do I record a user's investor self-categorization statement?
      - Can a user update how they categorize themselves as an investor?
      instructions:
      - text: Submit self-categorization statement {input}.
        slots:
          input: requestBody.input
      - text: Update my investor self-categorization to {input}.
        slots:
          input: requestBody.input
      method: generated
      generated: '2026-09-26'
- target: $.paths['/core/kyc/processes/tax-details'].patch
  update:
    x-apievangelist-phrasing:
      intent: Submit a user's tax details
      effect: write
      questions:
      - How do I submit a user's tax residency and tax ID?
      - Can I update the tax details step of KYC?
      instructions:
      - text: Submit tax details {input}.
        slots:
          input: requestBody.input
      - text: Update my KYC tax information with {input}.
        slots:
          input: requestBody.input
      method: generated
      generated: '2026-09-26'
- target: $.paths['/widgets/kyc/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a KYC widget session
      effect: write
      questions:
      - How do I launch the embedded KYC widget for a user?
      - Is there a hosted widget for running identity verification?
      instructions:
      - text: Create a KYC widget session.
      - text: Start the embedded KYC widget for this user.
      method: generated
      generated: '2026-09-26'