OpenMercantil · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenMercantil Risk Signals API

5 actions 5 updates phrasing extends openapi/openmercantil-risk-signals-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for OpenMercantil's API. It is a proposal applied on top of the contract, not a document OpenMercantil publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/api/v1/company/{slug}/sanctions'].get

$.paths['/api/v1/company/{slug}/risk-signals'].get

$.paths['/api/v1/company/{slug}/aeat-moroso'].get

$.paths['/api/v1/company/{slug}/embargoes'].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 OpenMercantil Risk Signals API
  version: 1.0.0
extends: openapi/openmercantil-risk-signals-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: 4
- target: $.paths['/api/v1/company/{slug}/sanctions'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a company against sanctions data
      effect: read
      questions:
      - Is a Spanish company on any sanctions list?
      - Why is the company sanctions dataset unavailable right now?
      instructions:
      - text: Check whether {company} appears in sanctions data.
        slots:
          company: path.slug
      - text: Screen {company} against the sanctions dataset.
        slots:
          company: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/company/{slug}/risk-signals'].get
  update:
    x-apievangelist-phrasing:
      intent: Get documentary risk signals for a company
      effect: read
      questions:
      - What risk signals are published for a Spanish company?
      - Does a missing risk signal mean the underlying fact doesn't exist?
      instructions:
      - text: Get the documentary risk signals for {company}.
        slots:
          company: path.slug
      - text: Show authorized risk flags on {company}.
        slots:
          company: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/company/{slug}/aeat-moroso'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a company is on the AEAT debtor list
      effect: read
      questions:
      - Does a Spanish company appear on the tax agency's list of debtors?
      - Would an AEAT debtor-list mention mean the company still owes tax?
      instructions:
      - text: Check whether {company} is on the AEAT moroso list.
        slots:
          company: path.slug
      - text: Look up {company} in the Hacienda debtor list.
        slots:
          company: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/company/{slug}/embargoes'].get
  update:
    x-apievangelist-phrasing:
      intent: List embargo mentions for a company
      effect: read
      questions:
      - Has a Spanish company had assets seized or embargoed according to public registries?
      - Do embargo mentions certify that an embargo is still in force?
      instructions:
      - text: List the embargo and garnishment mentions for {company}.
        slots:
          company: path.slug
      - text: Check {company} for published embargoes de bienes.
        slots:
          company: path.slug
      method: generated
      generated: '2026-09-26'