--- title: "Get a link to a Adyen-hosted onboarding page" method: POST path: "/getOnboardingUrl" tags: ["Hosted Onboarding Page"] --- # Get a link to a Adyen-hosted onboarding page `POST /getOnboardingUrl` Returns a link to an Adyen-hosted onboarding page (HOP) that you can send to your account holder. For more information on how to use HOP, refer to [Hosted onboarding](https://docs.adyen.com/classic-platforms/onboard-users/hosted-onboarding-page). ## Request body - GetOnboardingUrlRequest - `accountHolderCode` string, required — The account holder code you provided when you created the account holder. - `collectInformation` CollectInformation - `bankDetails` boolean — Indicates whether [bank account details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#bank-accounts) must be collected. Default is **true**. - `businessDetails` boolean — Indicates whether [business details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#organizations) must be collected. Default is **true**. - `individualDetails` boolean — Indicates whether [individual details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Default is **true**. - `legalArrangementDetails` boolean — Indicates whether [legal arrangement details](https://docs.adyen.com/classic-platforms/verification-checks/legal-arrangements) must be collected. Default is **true**. - `pciQuestionnaire` boolean — Indicates whether answers to a [PCI questionnaire](https://docs.adyen.com/classic-platforms/platforms-for-partners#onboard-partner-platform) must be collected. Applies only to partner platforms. Default is **true**. - `shareholderDetails` boolean — Indicates whether [shareholder details](https://docs.adyen.com/classic-platforms/verification-process/accepted-data-format/#individuals) must be collected. Defaults to **true**. - `editMode` boolean — Indicates if editing checks is allowed even if all the checks have passed. - `mobileOAuthCallbackUrl` string — The URL to which the account holder is redirected after completing an OAuth authentication with a bank through Trustly/PayMyBank. - `platformName` string — The platform name which will show up in the welcome page. - `returnUrl` string — The URL where the account holder will be redirected back to after they complete the onboarding, or if their session times out. Maximum length of 500 characters. If you don't provide this, the account holder will be redirected back to the default return URL configured in your platform account. - `shopperLocale` string — The language to be used in the page, specified by a combination of a language and country code. For example, **pt-BR**. If not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default. For a list of supported languages, refer to [Change the page language](https://docs.adyen.com/classic-platforms/hosted-onboarding-page/customize-experience#change-page-language). - `showPages` ShowPages - `bankDetailsSummaryPage` boolean — Indicates whether the page with bank account details must be shown. Defaults to **true**. - `bankVerificationPage` boolean — Indicates whether the bank check instant verification' details must be shown. Defaults to **true**. - `businessDetailsSummaryPage` boolean — Indicates whether the page with the company's or organization's details must be shown. Defaults to **true**. - `checksOverviewPage` boolean — Indicates whether the checks overview page must be shown. Defaults to **false**. - `individualDetailsSummaryPage` boolean — Indicates whether the page with the individual's details must be shown. Defaults to **true**. - `legalArrangementsDetailsSummaryPage` boolean — Indicates whether the page with the legal arrangements' details must be shown. Defaults to **true**. - `manualBankAccountPage` boolean — Indicates whether the page to manually add bank account' details must be shown. Defaults to **true**. - `shareholderDetailsSummaryPage` boolean — Indicates whether the page with the shareholders' details must be shown. Defaults to **true**. - `welcomePage` boolean — Indicates whether the welcome page must be shown. Defaults to **false**. ## Response `200` OK - the request has succeeded. - GetOnboardingUrlResponse - `invalidFields` ErrorFieldTypeWrapper[] — Information about any invalid fields. - `ErrorFieldType` ErrorFieldType - `errorCode` integer — The validation error code. - `errorDescription` string — A description of the validation error. - `fieldType` FieldType - `field` string — The full name of the property. - `fieldName` 'accountCode' | 'accountHolderCode' | 'accountHolderDetails' | 'accountNumber' | 'accountStateType' | 'accountStatus' | 'accountType' | 'address' | 'balanceAccount' | 'balanceAccountActive' | 'balanceAccountCode' | 'balanceAccountId' | 'bankAccount' | 'bankAccountCode' | 'bankAccountName' | 'bankAccountUUID' | 'bankBicSwift' | 'bankCity' | 'bankCode' | 'bankName' | 'bankStatement' | 'branchCode' | 'businessContact' | 'cardToken' | 'checkCode' | 'city' | 'companyRegistration' | 'constitutionalDocument' | 'controller' | 'country' | 'countryCode' | 'currency' | 'currencyCode' | 'dateOfBirth' | 'destinationAccountCode' | 'document' | 'documentContent' | 'documentExpirationDate' | 'documentIssuerCountry' | 'documentIssuerState' | 'documentName' | 'documentNumber' | 'documentType' | 'doingBusinessAs' | 'drivingLicence' | 'drivingLicenceBack' | 'drivingLicenceFront' | 'drivingLicense' | 'email' | 'firstName' | 'formType' | 'fullPhoneNumber' | 'gender' | 'hopWebserviceUser' | 'houseNumberOrName' | 'iban' | 'idCard' | 'idNumber' | 'identityDocument' | 'individualDetails' | 'infix' | 'jobTitle' | 'lastName' | 'lastReviewDate' | 'legalArrangement' | 'legalArrangementCode' | 'legalArrangementEntity' | 'legalArrangementEntityCode' | 'legalArrangementLegalForm' | 'legalArrangementMember' | 'legalArrangementMembers' | 'legalArrangementName' | 'legalArrangementReference' | 'legalArrangementRegistrationNumber' | 'legalArrangementTaxNumber' | 'legalArrangementType' | 'legalBusinessName' | 'legalEntity' | 'legalEntityType' | 'linkedViasVirtualAccount' | 'logo' | 'merchantAccount' | 'merchantCategoryCode' | 'merchantHouseNumber' | 'merchantReference' | 'microDeposit' | 'name' | 'nationality' | 'originalReference' | 'ownerCity' | 'ownerCountryCode' | 'ownerDateOfBirth' | 'ownerHouseNumberOrName' | 'ownerName' | 'ownerPostalCode' | 'ownerState' | 'ownerStreet' | 'passport' | 'passportNumber' | 'payoutMethod' | 'payoutMethodCode' | 'payoutSchedule' | 'pciSelfAssessment' | 'personalData' | 'phoneCountryCode' | 'phoneNumber' | 'postalCode' | 'primaryCurrency' | 'reason' | 'returnUrl' | 'schedule' | 'shareholder' | 'shareholderCode' | 'shareholderCodeAndSignatoryCode' | 'shareholderCodeOrSignatoryCode' | 'shareholderType' | 'shareholderTypes' | 'shopperInteraction' | 'signatory' | 'signatoryCode' | 'socialSecurityNumber' | 'sourceAccountCode' | 'splitAccount' | 'splitConfigurationUUID' | 'splitCurrency' | 'splitValue' | 'splits' | 'stateOrProvince' | 'status' | 'stockExchange' | 'stockNumber' | 'stockTicker' | 'store' | 'storeDetail' | 'storeName' | 'storeReference' | 'street' | 'taxId' | 'tier' | 'tierNumber' | 'transferCode' | 'ultimateParentCompany' | 'ultimateParentCompanyAddressDetails' | 'ultimateParentCompanyAddressDetailsCountry' | 'ultimateParentCompanyBusinessDetails' | 'ultimateParentCompanyBusinessDetailsLegalBusinessName' | 'ultimateParentCompanyBusinessDetailsRegistrationNumber' | 'ultimateParentCompanyCode' | 'ultimateParentCompanyStockExchange' | 'ultimateParentCompanyStockNumber' | 'ultimateParentCompanyStockNumberOrStockTicker' | 'ultimateParentCompanyStockTicker' | 'unknown' | 'value' | 'verificationType' | 'virtualAccount' | 'visaNumber' | 'webAddress' | 'year' — The type of the field. - `shareholderCode` string — The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder. - `pspReference` string — The reference of a request. Can be used to uniquely identify the request. - `redirectUrl` string — The URL to the Hosted Onboarding Page where you should redirect your sub-merchant. This URL must be used within 30 seconds and can only be used once. - `resultCode` string — The result code. - `submittedAsync` boolean — Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied: * **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received. * **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable. ## Other responses - `400` — Bad Request - a problem reading or understanding the request. - `401` — Unauthorized - authentication required. - `403` — Forbidden - insufficient permissions to process the request. - `422` — Unprocessable Entity - a request validation error. - `500` — Internal Server Error - the server could not process the request. ## Changes - **2024-03-04** (v1) `e3b2b1ba5fbd` — 1 warning - added the new `linkedViasVirtualAccount` enum value to the `invalidFields/items/ErrorFieldType/fieldType/fieldName` response property for the response status `200` - **2023-06-08** (v1) `30812dd75d8c` — 1 warning - added the new `payoutMethod` enum value to the `invalidFields/items/ErrorFieldType/fieldType/fieldName` response property for the response status `200` - **2023-04-12** (v1) `9917b4a65d66` — 1 breaking, 3 warning, 1 info - the `invalidFields/items/` response's property type/format changed from `object`/`` to ``/`` for status `200` - removed the optional property `invalidFields/items/errorCode` from the response with the `200` status - removed the optional property `invalidFields/items/errorDescription` from the response with the `200` status - removed the optional property `invalidFields/items/fieldType` from the response with the `200` status - …1 more - **2023-03-22** (v1) `f3c4e1becdce` — 11 breaking, 2 warning, 1 info - the request's body type/format changed from ``/`` to `object`/`` - the `collectInformation` request property type/format changed from ``/`` to `object`/`` - the `showPages` request property type/format changed from ``/`` to `object`/`` - the response's body type/format changed from ``/`` to `object`/`` for status `200` - …10 more - …earlier changes not shown [Full history](https://skmtc.dev/adyen/apis/hopservice/changes/getOnboardingUrl/post.md) --- [API](https://skmtc.dev/adyen/apis/hopservice.md) · [All operations](https://skmtc.dev/adyen/apis/hopservice/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/adyen/hopservice/revisions/b2b000b1161e/schema)