AlgoVoi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Algovoi Co Uk Compliance API

6 actions 6 updates phrasing extends openapi/algovoi-co-uk-compliance-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for AlgoVoi's API. It is a proposal applied on top of the contract, not a document AlgoVoi publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/compliance/attestation'].get
$.paths['/compliance/screen'].post
$.paths['/compliance/trust-query'].post
$.paths['/v1/receipt/verify'].post
$.paths['/v1/receipt/settlement-evidence/{settled_payment_ref}'].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 Algovoi Co Uk Compliance API
  version: 1.0.0
extends: openapi/algovoi-co-uk-compliance-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: 5
- target: $.paths['/compliance/attestation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the gateway's compliance attestation
      effect: read
      questions:
      - What is the payment gateway's full compliance posture?
      - Is the compliance transparency surface free and unrate-limited?
      instructions:
      - text: Fetch the gateway's compliance attestation.
      - text: Show me the published compliance posture document.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/compliance/screen'].post
  update:
    x-apievangelist-phrasing:
      intent: Screen a recipient wallet before paying
      effect: read
      questions:
      - How do I screen a wallet address for sanctions before sending it money?
      - Can I include the amount and asset when screening a payment recipient?
      instructions:
      - text: Screen recipient {recipient_address} on {network} before payment.
        slots:
          recipient_address: requestBody.recipient_address
          network: requestBody.network
      - text: Check wallet {recipient_address} on {network} for a {amount_microunits} microunit payment of {asset}.
        slots:
          recipient_address: requestBody.recipient_address
          network: requestBody.network
          amount_microunits: requestBody.amount_microunits
          asset: requestBody.asset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/compliance/trust-query'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a composite trust verdict over receipts
      effect: read
      questions:
      - Can I get one trust verdict over a chain of compliance, settlement, refund and cancellation receipts?
      - What verdicts can a trust query return, TRUSTED, PROVISIONAL, INSUFFICIENT_EVIDENCE or UNTRUSTED?
      instructions:
      - text: Run a composite trust query over receipts {receipts}.
        slots:
          receipts: requestBody.receipts
      - text: Score this chain of substrate receipts {receipts} and return the signed verdict.
        slots:
          receipts: requestBody.receipts
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/receipt/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a JWS compliance receipt
      effect: read
      questions:
      - How do I cryptographically verify a compliance receipt or settlement attestation?
      - Can receipt verification also check the payment hash binding?
      instructions:
      - text: Verify compliance receipt JWS {jws}.
        slots:
          jws: requestBody.jws
      - text: Check receipt {jws} is bound to payment hash {expected_payment_hash}.
        slots:
          jws: requestBody.jws
          expected_payment_hash: requestBody.expected_payment_hash
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/receipt/settlement-evidence/{settled_payment_ref}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch on-chain settlement evidence for a payment
      effect: read
      questions:
      - Has the chain evidence for one of my settled payments been captured yet?
      - Can I download an offline-verifiable state-proof bundle for a settled payment?
      instructions:
      - text: Get settlement evidence for payment ref {settled_payment_ref}.
        slots:
          settled_payment_ref: path.settled_payment_ref
      - text: Fetch the state-proof bundle captured for {settled_payment_ref}.
        slots:
          settled_payment_ref: path.settled_payment_ref
      method: generated
      generated: '2026-10-01'