Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Hosted Onboarding Get Onboarding URL API

2 actions 2 updates phrasing extends openapi/adyen-getonboardingurl-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/getOnboardingUrl'].post

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 Adyen Hosted Onboarding Get Onboarding URL API
  version: 1.0.0
extends: openapi/adyen-getonboardingurl-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: 1
- target: $.paths['/getOnboardingUrl'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a hosted onboarding link for an account holder
      effect: read
      questions:
      - Can I send my sub-merchant a link to fill in their KYC details on a hosted page?
      - Where does the account holder land after finishing hosted onboarding?
      instructions:
      - text: Get a hosted onboarding URL for account holder {accountHolderCode}.
        slots:
          accountHolderCode: requestBody.accountHolderCode
      - text: Create an onboarding link for {accountHolderCode} that returns to {returnUrl} in locale {shopperLocale}.
        slots:
          accountHolderCode: requestBody.accountHolderCode
          returnUrl: requestBody.returnUrl
          shopperLocale: requestBody.shopperLocale
      method: generated
      generated: '2026-09-26'