Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign Idv Evidence Summary API

4 actions 4 updates phrasing extends openapi/conga-idvevidencesummary-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 4

$.info

$.paths['/v1/cs-packages/{packageId}/audit/idv'].get

$.paths['/v1/cs-packages/{packageId}/audit/idv/dvrImageUrls'].get

$.paths['/v1/cs-packages/{packageId}/audit/idv/dvrSignerImage'].get

OpenAPI Overlay

# 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 Evidence Summary API
  version: 1.0.0
extends: openapi/conga-idvevidencesummary-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: 3
- target: $.paths['/v1/cs-packages/{packageId}/audit/idv'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a package's identity verification evidence
      effect: read
      questions:
      - What identity verification evidence was captured for a signing package?
      - Can I get the IDV audit summary as JSON?
      instructions:
      - text: Get the IDV evidence summary for package {packageId}.
        slots:
          packageId: path.packageId
      - text: Show identity verification audit for package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/audit/idv/dvrImageUrls'].get
  update:
    x-apievangelist-phrasing:
      intent: List IDV verification report image URLs
      effect: read
      questions:
      - Which images are in the detailed verification report for a package?
      - Can I list the image URLs from an identity check?
      instructions:
      - text: List IDV report image URLs for package {packageId}.
        slots:
          packageId: path.packageId
      - text: Get verification report images on package {packageId}.
        slots:
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/audit/idv/dvrSignerImage'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an IDV signer image
      effect: read
      questions:
      - Can I download the signer's ID image from a verification?
      - What do I need to fetch one IDV image as a file?
      instructions:
      - text: Download the IDV signer image for package {packageId}.
        slots:
          packageId: path.packageId
      - text: Download image {imageUrl} from IDV transaction {idvTransactionId} on package {packageId}.
        slots:
          imageUrl: query.imageUrl
          idvTransactionId: query.idvTransactionId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'