Generated by API Evangelist
Written by API Evangelist tooling for Adyen's API. It is a proposal applied on top of the contract, not a document Adyen publishes.
# 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 Documents API
version: 1.0.0
extends: openapi/adyen-documents-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['/documents'].post
update:
x-apievangelist-phrasing:
intent: Upload a verification document
effect: write
questions:
- How do I upload an ID or proof of address for KYC verification?
- What happens if automated verification checks on a legal entity fail?
instructions:
- text: Upload a {type} document described as {description} with attachment {attachment}.
slots:
type: requestBody.type
description: requestBody.description
attachment: requestBody.attachment
- text: Upload a {type} document for owner {owner}, described as {description}.
slots:
type: requestBody.type
owner: requestBody.owner
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/documents/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an uploaded document
effect: read
questions:
- Can I retrieve a verification document I uploaded earlier?
- What details are stored with an uploaded document?
instructions:
- text: Get document {id}.
slots:
id: path.id
- text: Show the uploaded verification file {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/documents/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an uploaded document
effect: destructive
questions:
- How do I remove a verification document that was uploaded by mistake?
- Can I delete a KYC document permanently?
instructions:
- text: Delete document {id}.
slots:
id: path.id
- text: Remove the verification file {id} permanently.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/documents/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Replace or correct an uploaded document
effect: write
questions:
- Can I add more pages to an existing ID document?
- What's the page limit when updating a photo ID document?
instructions:
- text: Update document {id} of type {type} with description {description} and attachments {attachments}.
slots:
id: path.id
type: requestBody.type
description: requestBody.description
attachments: requestBody.attachments
- text: Correct the expiry date of existing document {id} to {expiryDate}.
slots:
id: path.id
expiryDate: requestBody.expiryDate
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.