Adyen Hosted Onboarding API

Name: Adyen Hosted Onboarding API
Brand: Adyen Hosted Onboarding API
Availability: InStock

✓ Official Vendor SpecIdentity AuthIdentity VerificationapiKey, basic2 Endpoints

Install Jentic One Beta

Connect the Adyen Hosted Onboarding API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Adyen Hosted Onboarding API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Adyen Hosted Onboarding API.

Generate a one-time URL to the Adyen-hosted onboarding page for a specific account holder

Generate a URL to the Adyen-hosted PCI compliance questionnaire for an account holder

Pass return URLs so that account holders are redirected back to the platform once they finish onboarding

GET STARTED

Start building with Adyen Hosted Onboarding API

Explore with Jentic

View OpenAPI Document

For Agents

Generate links to Adyen-hosted onboarding and PCI compliance pages for marketplace account holders on Adyen's classic for-platforms integration.

Use for: I need to generate an Adyen onboarding link for a new marketplace seller, Get the URL of the PCI compliance questionnaire for an account holder, Send a hosted onboarding link to a seller to finish KYC details, Create a one-off PCI questionnaire link for a partner platform

Not supported: Does not handle account creation, document upload, or balance management - use for generating hosted onboarding and PCI questionnaire URLs only.

Use Cases

Patterns agents use Adyen Hosted Onboarding API for, with concrete tasks.

★ Marketplace Seller Onboarding Flow

Embed Adyen's hosted onboarding page in a marketplace's seller signup flow rather than building a bespoke KYC UI. After creating an account holder via the Account API, call /getOnboardingUrl with the account holder code, redirect the seller to the returned URL, and capture the return URL once they submit verification details. Reduces time-to-launch because Adyen handles the UI, localisation, and verification status updates.

POST /getOnboardingUrl with accountHolderCode seller_8421 and returnUrl https://example.com/onboarding/done, then redirect the seller to the returned redirectUrl

PCI Compliance Questionnaire

Direct partner platforms or higher-risk account holders to Adyen's hosted PCI compliance questionnaire so they can complete their self-assessment without the marketplace building its own questionnaire UI. Call /getPciQuestionnaireUrl with the account holder code, share the returned link, and rely on Adyen to record completion. Useful for platforms-for-partners scenarios where each partner takes responsibility for PCI compliance.

POST /getPciQuestionnaireUrl with accountHolderCode partner_4071 and returnUrl https://example.com/pci/done, then email the returned redirectUrl to the partner contact

AI Agent Onboarding Concierge

AI agents in support tooling can resend onboarding or PCI links to sellers who lost their session, without raw access to the Adyen API key. The agent searches Jentic for 'generate Adyen onboarding URL', retrieves the /getOnboardingUrl schema with required accountHolderCode and returnUrl fields, and executes the call. The link is delivered back to the seller through the support channel while credentials remain isolated in your Jentic One instance.

Search Jentic for 'generate Adyen onboarding URL', load the schema, then POST /getOnboardingUrl for the accountHolderCode pulled from the support ticket and reply with the returned redirectUrl

Key Endpoints

2 endpoints — generate links to adyen-hosted onboarding and pci compliance pages for marketplace account holders on the adyen for platforms classic integration.

METHOD

PATH

DESCRIPTION

POST

/getOnboardingUrl

Get a link to the Adyen-hosted onboarding page

POST

/getPciQuestionnaireUrl

Get a link to the PCI compliance questionnaire

POST

/getOnboardingUrl

Get a link to the Adyen-hosted onboarding page

POST

/getPciQuestionnaireUrl

Get a link to the PCI compliance questionnaire

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your Adyen X-API-Key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'generate an adyen onboarding link' or 'get a PCI questionnaire URL', and Jentic returns the matching Hosted Onboarding operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

Time to first call

FAQs

Specific to using Adyen Hosted Onboarding API through Jentic.

What authentication does the Adyen Hosted Onboarding API use?

The Hosted Onboarding API accepts an API key in the X-API-Key header or HTTP Basic authentication with web service user credentials. Generate the key from your Adyen Customer Area. Through Jentic, your X-API-Key is stored encrypted in your Jentic One instance and agents authenticate with scoped tokens, keeping the raw key out of agent context.

Can I customise the Adyen-hosted onboarding page?

Customisation is limited to settings configured in your Adyen Customer Area (logos, terms of service URL, supported locales). The API itself only generates the URL - you cannot pass per-call branding parameters. The returnUrl is the main per-call control, used to redirect the account holder back into your flow after they submit their details.

What are the rate limits for the Hosted Onboarding API?

Rate limits are tied to your platform contract and are typically low because URL generation is a one-off operation per onboarding session. Excess calls return HTTP 429. If you need to regenerate links in bulk (for example after a session timeout policy change), back off on rate limits and contact your Adyen account team.

How do I generate an onboarding link through Jentic?

Search Jentic for 'generate Adyen onboarding URL' to find the POST /getOnboardingUrl operation. Required fields are accountHolderCode and returnUrl, with optional fields for locale and platform identifier. Jentic loads the full schema and executes with vaulted credentials. Run it through Jentic One, the self-hosted execution layer.

How long does the returned onboarding URL remain valid?

The returned URL is single-use and expires after the account holder completes the flow or after the session timeout configured for your platform. If the account holder abandons the page and comes back later, regenerate a new URL via /getOnboardingUrl rather than reusing the old one.

Can I limit what my agent is allowed to do with the Adyen Hosted Onboarding API?

Yes. Because Jentic One is self-hosted, you set the rules that decide which operations and credentials your agent may use, and this API exposes only two calls: POST /getOnboardingUrl to mint a hosted onboarding link and POST /getPciQuestionnaireUrl to mint a PCI questionnaire link. You can allow the agent just one of these, for example only generating onboarding URLs, and both take the accountHolderCode and returnUrl in the request body rather than a resource id in the path. Your Adyen X-API-Key stays encrypted in your own instance and is injected at execution time, so it never enters the agent's prompt or context.

Adyen Hosted Onboarding API

Connect the Adyen Hosted Onboarding API to your agent

Capabilities

Start building with Adyen Hosted Onboarding API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs