canonical: https://jentic.com/apis/adyen.com/adyen-account-service # Adyen Account API Onboard and manage marketplace account holders, sub-accounts, and their associated bank accounts and shareholders on the Adyen for Platforms classic integration. The API handles the full account lifecycle from creation through KYC verification, document upload, and suspension or closure. Each account holder can contain multiple accounts with separate balances and payout configurations. ## For AI agents Create and manage marketplace account holders, sub-accounts, bank accounts, and shareholders on Adyen's classic platform integration. Handles KYC verification and document uploads for marketplace onboarding. ## Scope Does not handle payment processing, checkout flows, or terminal management - use for marketplace account onboarding and management only. ## Capabilities - Create account holders with business details, legal entity information, and payout schedules - Attach bank accounts and verification documents to account holders for KYC compliance - Suspend and reactivate account holders based on compliance status or platform policy - Upload identity documents and tax forms to satisfy regulatory verification requirements - Retrieve account holder details including verification status, balance, and payout configuration - Close accounts and account holders with final payout processing and record retention ## Use cases ### AI Agent Marketplace Onboarding AI agents automate marketplace seller onboarding through Jentic by creating account holders, attaching bank accounts, and uploading verification documents without directly managing Adyen API keys. An agent searches for 'create an account holder' via Jentic, receives the operation schema with required legal entity fields, and executes the call. Subsequent verification document uploads and status checks follow the same pattern. Example prompt: Search Jentic for 'create Adyen account holder', load the schema, create an account holder with business details and legal entity type, then upload an identity document via /uploadDocument ### Marketplace Seller Onboarding Onboard new sellers on a marketplace platform by creating account holders with business registration details, attaching bank accounts for payouts, and initiating KYC verification. The API supports individual and business entity types with fields for shareholders, UBO declarations, and legal arrangements. Verification runs automatically after document upload and returns status via the /getAccountHolder endpoint. Example prompt: Create an account holder with legalEntity type Business, add a bank account via the accountHolder payload, then call /checkAccountHolder to initiate KYC verification ### KYC Document Management Upload and manage identity verification documents required for regulatory compliance across different jurisdictions. The uploadDocument endpoint accepts base64-encoded files (passport, driving license, bank statement) and associates them with specific account holders or shareholders. Document verification status is returned in the account holder details response. Example prompt: Upload a base64-encoded passport image for an account holder using POST /uploadDocument with documentType PASSPORT, then retrieve the account holder to check verification status ### Account Lifecycle Management Manage the full lifecycle of marketplace accounts from active trading through suspension, reactivation, and eventual closure. The API provides separate endpoints for suspending account holders (freezing payouts and trading), unsuspending them after compliance resolution, and permanently closing accounts with final balance settlement. Example prompt: Suspend an account holder using POST /suspendAccountHolder with the accountHolderCode, verify suspension status, then reactivate with POST /unSuspendAccountHolder ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | /createAccountHolder | Create a new account holder with business details | | POST | /createAccount | Create a sub-account under an account holder | | POST | /getAccountHolder | Retrieve account holder details and verification status | | POST | /updateAccountHolder | Update account holder information | | POST | /uploadDocument | Upload verification documents for KYC | | POST | /suspendAccountHolder | Suspend an account holder | | POST | /closeAccountHolder | Close an account holder permanently | | POST | /checkAccountHolder | Trigger verification checks on account holder | ## Key resources - **Account Holders** — Legal entities (individuals or businesses) that own sub-accounts on the platform - **Accounts** — Sub-accounts under account holders with separate balances and payout configurations - **Bank Accounts** — Payout destination bank accounts attached to account holders - **Shareholders** — Beneficial owners and directors associated with business account holders - **Documents** — Identity and compliance documents uploaded for KYC verification ## Why Jentic - **Setup:** Wiring the Adyen Account API by hand means handling its X-API-Key or basic auth, targeting the classic CAL host, and assembling the legal-entity fields each onboarding call requires. Through Jentic you install once, import the Account API from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** The Account API takes the account holder in the request body rather than a resource id in the URL path, so you limit the agent to the operations it needs, such as creating an account holder or uploading a verification document. Because you pick the operations, destructive ones like suspend or close stay out unless you include them. - **Credential handling:** 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. - **Discovery method:** Agents search Jentic by intent such as 'onboard a marketplace seller' or 'upload a verification document', and Jentic returns the matching Account API operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Adyen Checkout API** — Process payments for the accounts managed through the Account API - **Adyen Payout API** — Send payouts to the bank accounts configured on account holders - **Stripe API** — Stripe Connect provides similar marketplace account onboarding with a developer-first approach - **Adyen Balance Platform API** — Modern replacement for the classic Account API with balance accounts and transfers ## FAQ ### What authentication does the Adyen Account API use? The Adyen Account API accepts an API key via the X-API-Key header or HTTP Basic authentication with your web service user credentials (ws@MarketPlace.YOUR_PLATFORM_ACCOUNT as username). Through Jentic, your Adyen API key is stored encrypted in your Jentic One instance and agents receive scoped access without seeing the raw key. ### Can I create account holders for both individuals and businesses? Yes. The POST /createAccountHolder endpoint accepts a legalEntity field with type Individual or Business. Individual entities require personal details (name, date of birth, address). Business entities additionally require registration number, shareholders, and UBO declarations. Verification requirements differ by entity type and jurisdiction. ### What are the rate limits for the Adyen Account API? Adyen applies per-endpoint rate limits based on your contract tier, typically 30-60 requests per second for account management operations. The /uploadDocument endpoint has lower limits due to payload size. If exceeded, the API returns HTTP 429. Contact your Adyen account manager for limit increases on high-volume onboarding flows. ### How do I upload KYC documents through the Adyen Account API via Jentic? Search Jentic for 'upload verification document' to find the POST /uploadDocument operation. Required fields are accountHolderCode, documentDetail (with documentType such as PASSPORT or BANK_STATEMENT), and the base64-encoded file content. Jentic loads the full schema including supported document types. Run it through Jentic One, the self-hosted execution layer. ### What verification document types does the Account API accept? The /uploadDocument endpoint accepts PASSPORT, DRIVING_LICENCE, ID_CARD, BANK_STATEMENT, INCORPORATION_CERTIFICATE, and COMPANY_REGISTRATION_SCREENING. Documents must be base64-encoded and under 10MB. The response confirms upload status and the /getAccountHolder response shows which verification checks are pending or complete. ### Is the Account API part of the Adyen classic or new integration? The Account API (v6) is part of Adyen's classic integration for platforms. New implementations should consider the Adyen Balance Platform APIs instead, which provide a more modern architecture. The classic Account API remains fully supported for existing integrations and handles account holders, sub-accounts, bank accounts, and KYC flows. ### Can I limit what my agent is allowed to do with the Adyen Account API? Yes. Jentic One is self-hosted by you, so your own rules decide which Account API operations and credentials your agent may use. Because the Account API takes the account holder in the request body rather than a resource id in the URL path, you scope the agent to just the operations it needs, such as createAccountHolder or uploadDocument. Since you choose the allowed operations, destructive calls like suspendAccountHolder or closeAccountHolder stay out of reach unless you deliberately include them.