CreateAccountHolderRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/accounts-create-account-holder-request-schema.json",
  "title": "CreateAccountHolderRequest",
  "description": "CreateAccountHolderRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "accountHolderCode": {
      "description": "Your unique identifier for the prospective account holder.\nThe length must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are allowed.",
      "type": "string"
    },
    "accountHolderDetails": {
      "description": "The details of the prospective account holder.",
      "$ref": "#/components/schemas/AccountHolderDetails"
    },
    "createDefaultAccount": {
      "description": "If set to **true**, an account with the default options is automatically created for the account holder.\nBy default, this field is set to **true**.",
      "type": "boolean"
    },
    "description": {
      "x-addedInVersion": "4",
      "description": "A description of the prospective account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.",
      "type": "string"
    },
    "legalEntity": {
      "description": "The legal entity type of the account holder. This determines the information that should be provided in the request.\n\nPossible values: **Business**, **Individual**, or **NonProfit**.\n\n* If set to **Business** or **NonProfit**, then `accountHolderDetails.businessDetails` must be provided, with at least one entry in the `accountHolderDetails.businessDetails.shareholders` list.\n\n* If set to **Individual**, then `accountHolderDetails.individualDetails` must be provided.",
      "enum": [
        "Business",
        "Individual",
        "NonProfit",
        "Partnership",
        "PublicCompany"
      ],
      "type": "string"
    },
    "primaryCurrency": {
      "x-addedInVersion": "4",
      "deprecated": true,
      "description": "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.",
      "type": "string"
    },
    "processingTier": {
      "x-addedInVersion": "3",
      "description": "The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.",
      "format": "int32",
      "type": "integer"
    },
    "verificationProfile": {
      "x-addedInVersion": "6",
      "description": "The identifier of the profile that applies to this entity.",
      "type": "string"
    }
  },
  "required": [
    "accountHolderCode",
    "legalEntity",
    "accountHolderDetails"
  ]
}