Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign Idv Workflow API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/cs-accountconfig/idvWorkflowConfigs'].get
$.paths['/v1/cs-accountconfig/idvWorkflowConfigs'].put
$.paths['/v1/cs-accountconfig/idvWorkflowConfigs'].post
$.paths['/v1/cs-accountconfig/idvWorkflowConfigs'].delete

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 Conga Sign Idv Workflow API
  version: 1.0.0
extends: openapi/conga-idvworkflow-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v1/cs-accountconfig/idvWorkflowConfigs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the IDV workflow configuration
      effect: read
      questions:
      - What identity verification workflow is configured for our signing account?
      - Can I see the current IDV workflow configs as JSON?
      instructions:
      - text: Show the account's IDV workflow configuration.
      - text: Fetch the current identity verification workflow settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-accountconfig/idvWorkflowConfigs'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the IDV workflow configuration
      effect: write
      questions:
      - Can I change the existing identity verification workflow settings?
      - Do IDV workflow changes have to be enabled in the back office first?
      instructions:
      - text: Update the existing IDV workflow configuration.
      - text: Apply my changes to the identity verification workflow config.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-accountconfig/idvWorkflowConfigs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IDV workflow configuration
      effect: write
      questions:
      - How do I set up a new DV or DVF identity verification workflow?
      - Which kinds of IDV workflow configurations can be created?
      instructions:
      - text: Create a new IDV workflow configuration for the account.
      - text: Add a DVF identity verification workflow configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-accountconfig/idvWorkflowConfigs'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the IDV workflow configuration
      effect: destructive
      questions:
      - Can I remove the identity verification workflow from the account?
      - What happens to signing when the IDV workflow config is deleted?
      instructions:
      - text: Delete the IDV workflow configuration.
      - text: Remove our identity verification workflow setup.
      method: generated
      generated: '2026-10-01'