Hosted onboarding API
This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead. The Hosted onboarding API provides endpoints that you can use to generate links to Adyen-hosted pages, such as an [onboarding page](https://docs.adyen.com/marketplaces-and-platforms/classic/hosted-onboarding-page) or a [PCI compliance questionnaire](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners). You can provide these links to your account holders so that they can complete their onboarding. ## Authentication Your Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_API_KEY" \ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication. For example: ``` curl -U "[email protected]_PLATFORM_ACCOUNT":"YOUR_WS_PASSWORD" \ -H "Content-Type: application/json" \ ... ``` When going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Hosted onboarding API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Hop/v6/getOnboardingUrl ```
Description supplied by the publisher; it is a claim, not verified evidence.
- Name
- apisguru:adyen.com:HopService
- Listed in
- APIs.guru
- Publisher
- adyen.com
- Latest version
- 6
- Published
- 2023-03-22
- Evidence
- Listed only, not analyzed yet
What a full analysis of Hosted onboarding API checks
Not checked yet. About 60 tools are analyzed every hour; each check links to its source when it runs:
- Publisher identity: not checked yet
- Repository ownership: not checked yet
- Organization verification: not checked yet
- Artifact provenance: not checked yet
- Source availability: not checked yet
- Version evidence: not checked yet
- Known vulnerabilities: not checked yet
- Install scripts: not checked yet
- Maintenance: not checked yet
- License: not checked yet
Before you install it
- Open the repository and confirm the account is the one you expect: look-alike names are common.
- Read what it asks for: files, accounts, network access and credentials it needs.
- Prefer a version from a verified publisher when one exists.