# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adyen Legal Entity Management Legal Entities API
  version: 1.0.0
extends: openapi/adyen-legalentities-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: 15
- target: $.paths['/legalEntities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a legal entity for onboarding
      effect: write
      questions:
      - How do I onboard a new user by creating a legal entity?
      - Which legal entity types can I create, like individual or organization?
      instructions:
      - text: Create a {type} legal entity.
        slots:
          type: requestBody.type
      - text: Create an individual legal entity with details {individual}.
        slots:
          individual: requestBody.individual
      - text: Create an organization legal entity for {organization} with reference {ref}.
        slots:
          organization: requestBody.organization
          ref: requestBody.reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a legal entity
      effect: read
      questions:
      - What information is stored on a legal entity?
      - Can I retrieve a legal entity by its ID?
      instructions:
      - text: Get legal entity {id}.
        slots:
          id: path.id
      - text: Show the onboarding details held for legal entity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a legal entity
      effect: write
      questions:
      - Can I change the type of an existing legal entity?
      - Do I have to replace the whole entity associations array when updating?
      instructions:
      - text: Change legal entity {id} to type {type}.
        slots:
          id: path.id
          type: requestBody.type
      - text: Replace the entity associations of legal entity {id} with {associations}.
        slots:
          id: path.id
          associations: requestBody.entityAssociations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}/businessLines'].get
  update:
    x-apievangelist-phrasing:
      intent: List a legal entity's business lines
      effect: read
      questions:
      - Which business lines does a legal entity own?
      - Can I see all lines of business registered under one legal entity?
      instructions:
      - text: List the business lines of legal entity {id}.
        slots:
          id: path.id
      - text: Show every line of business owned by legal entity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}/checkVerificationErrors'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a legal entity's verification errors
      effect: read
      questions:
      - Why is my user's verification failing?
      - Can I see verification errors for a legal entity and its supporting entities?
      instructions:
      - text: Check verification errors for legal entity {id}.
        slots:
          id: path.id
      - text: Find out what is blocking verification of legal entity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}/confirmDataReview'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm a user reviewed their data
      effect: write
      questions:
      - How do I tell Adyen my user has confirmed their onboarding data is up to date?
      - Does confirming a data review return when it was recorded?
      instructions:
      - text: Confirm that the user reviewed the data for legal entity {id}.
        slots:
          id: path.id
      - text: Record a data review confirmation for legal entity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}/onboardingLinks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a hosted onboarding link
      effect: write
      questions:
      - Can I send my user to a hosted onboarding page instead of building my own?
      - Can I choose the theme, locale and redirect URL of a hosted onboarding link?
      instructions:
      - text: Create a hosted onboarding link for legal entity {id}.
        slots:
          id: path.id
      - text: Get an onboarding link for {id} in locale {locale} that returns to {redirect}.
        slots:
          id: path.id
          locale: requestBody.locale
          redirect: requestBody.redirectUrl
      - text: Create an onboarding page link for legal entity {id} using theme {theme}.
        slots:
          id: path.id
          theme: requestBody.themeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}/pciQuestionnaires'].get
  update:
    x-apievangelist-phrasing:
      intent: List signed PCI questionnaires
      effect: read
      questions:
      - Which PCI questionnaires has a legal entity signed?
      - Can I see all signed PCI questionnaires for my user?
      instructions:
      - text: List the signed PCI questionnaires for legal entity {id}.
        slots:
          id: path.id
      - text: Show all PCI questionnaires legal entity {id} has signed.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}/pciQuestionnaires/generatePciTemplates'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate required PCI questionnaires
      effect: write
      questions:
      - Which PCI questionnaires does my user need based on their sales channel?
      - Can I generate PCI questionnaires in a specific language?
      instructions:
      - text: Generate the PCI questionnaires required for legal entity {id}.
        slots:
          id: path.id
      - text: Generate PCI questionnaire templates for legal entity {id} in {language}.
        slots:
          id: path.id
          language: requestBody.language
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}/pciQuestionnaires/signPciTemplates'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign PCI questionnaires
      effect: write
      questions:
      - How does my user sign the PCI questionnaires they were given?
      - Who has to be named as the signer of a PCI questionnaire?
      instructions:
      - text: Sign PCI templates {templates} for legal entity {id}, signed by {signer}.
        slots:
          id: path.id
          templates: requestBody.pciTemplateReferences
          signer: requestBody.signedBy
      - text: Have {signer} sign the PCI questionnaires {templates} on legal entity {id}.
        slots:
          id: path.id
          templates: requestBody.pciTemplateReferences
          signer: requestBody.signedBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}/pciQuestionnaires/{pciid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a signed PCI questionnaire
      effect: read
      questions:
      - Can I download one specific signed PCI questionnaire?
      - What does a signed PCI questionnaire record contain?
      instructions:
      - text: Get PCI questionnaire {pci} for legal entity {id}.
        slots:
          id: path.id
          pci: path.pciid
      - text: Retrieve the signed questionnaire {pci} of legal entity {id}.
        slots:
          id: path.id
          pci: path.pciid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}/termsOfService'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a Terms of Service document
      effect: read
      questions:
      - Where can I get the Terms of Service my user has to accept?
      - Can I get the Terms of Service document in my user's language?
      instructions:
      - text: Get the {type} Terms of Service document for legal entity {id} in {language}.
        slots:
          id: path.id
          type: requestBody.type
          language: requestBody.language
      - text: Fetch the {language} Terms of Service of type {type} for {id}.
        slots:
          id: path.id
          type: requestBody.type
          language: requestBody.language
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}/termsOfService/{termsofservicedocumentid}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Accept Terms of Service
      effect: write
      questions:
      - How do I record that my user accepted the Terms of Service?
      - Can I include the IP address of the person accepting the terms?
      instructions:
      - text: Accept Terms of Service document {doc} for legal entity {id} on behalf of {acceptedBy}.
        slots:
          id: path.id
          doc: path.termsofservicedocumentid
          acceptedBy: requestBody.acceptedBy
      - text: Record that {acceptedBy} accepted terms {doc} for {id} from IP {ip}.
        slots:
          id: path.id
          doc: path.termsofservicedocumentid
          acceptedBy: requestBody.acceptedBy
          ip: requestBody.ipAddress
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}/termsOfServiceAcceptanceInfos'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Terms of Service acceptance history
      effect: read
      questions:
      - Who accepted the Terms of Service for a legal entity, and when?
      - Can I see the acceptance records for a user's Terms of Service?
      instructions:
      - text: Get the Terms of Service acceptance info for legal entity {id}.
        slots:
          id: path.id
      - text: Show who accepted which terms for legal entity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/legalEntities/{id}/termsOfServiceStatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which Terms of Service are still required
      effect: read
      questions:
      - Which Terms of Service types does my user still need to accept?
      - Is a legal entity missing any Terms of Service acceptance?
      instructions:
      - text: Check the Terms of Service status of legal entity {id}.
        slots:
          id: path.id
      - text: List the terms types legal entity {id} must still accept.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'