Adyen · Schema

OnboardingLinkInfo

PaymentsFinancial ServicesFintech

Properties

Name Type Description
locale string The language that will be used for the page, specified by a combination of two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language and [ISO 3166-1 alpha-2](https://en.wi
redirectUrl string The URL where the user is redirected after they complete hosted onboarding.
settings object Boolean key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings. Possible keys: By default, these values are set to **true**. Set to **false** to not allow th
themeId string The unique identifier of the hosted onboarding theme.
View JSON Schema on GitHub

JSON Schema

adyen-onboardinglinkinfo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OnboardingLinkInfo",
  "title": "OnboardingLinkInfo",
  "properties": {
    "locale": {
      "description": "The language that will be used for the page, specified by a combination of two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language and [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. See [possible values](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/hosted#supported-languages). \n\nIf 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.",
      "type": "string"
    },
    "redirectUrl": {
      "description": "The URL where the user is redirected after they complete hosted onboarding.",
      "type": "string"
    },
    "settings": {
      "additionalProperties": {
        "type": "boolean"
      },
      "description": "Boolean key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings.\n\nPossible keys:\n\nBy default, these values are set to **true**. Set to **false** to not allow the action.\n\n- **changeLegalEntityType**: The user can change their legal entity type.\n\n- **editPrefilledCountry**: The user can change the country of their legal entity's address, for example the registered address of an organization.\n\nBy default, these values are set to **false**. Set to **true** to allow the action.\n\n- **allowBankAccountFormatSelection**: The user can select the format for their payout account if applicable.\n\n- **allowIntraRegionCrossBorderPayout**: The user can select a payout account in a different EU/EEA country than the country of their legal entity.\n\nBy default, these value are set to **false**. Set the following values to **true** to require the user to sign PCI questionnaires based on their sales channels. The user must sign PCI questionnaires for all relevant sales channels.\n\n- **requirePciSignEcommerce**\n\n- **requirePciSignPos**\n\n- **requirePciSignEcomMoto**\n\n- **requirePciSignPosMoto**\n\n",
      "type": "object"
    },
    "themeId": {
      "description": "The unique identifier of the hosted onboarding theme.",
      "type": "string"
    }
  },
  "type": "object"
}