AccountHolderInfo

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/configuration-account-holder-info-schema.json",
  "title": "AccountHolderInfo",
  "description": "AccountHolderInfo schema from Adyen API",
  "type": "object",
  "properties": {
    "balancePlatform": {
      "description": "The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.",
      "type": "string"
    },
    "capabilities": {
      "additionalProperties": {
        "$ref": "#/components/schemas/AccountHolderCapability"
      },
      "description": "Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.",
      "type": "object"
    },
    "contactDetails": {
      "deprecated": true,
      "description": "Contact details of the account holder.",
      "$ref": "#/components/schemas/ContactDetails"
    },
    "description": {
      "description": "Your description for the account holder, maximum 300 characters.",
      "maxLength": 300,
      "type": "string"
    },
    "legalEntityId": {
      "description": "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.",
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "A set of key and value pairs for general use.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.",
      "type": "object"
    },
    "migratedAccountHolderCode": {
      "description": "The unique identifier of the migrated account holder in the classic integration.",
      "readOnly": true,
      "type": "string"
    },
    "reference": {
      "description": "Your reference for the account holder, maximum 150 characters.",
      "maxLength": 150,
      "type": "string"
    },
    "timeZone": {
      "description": "The time zone of the account holder. For example, **Europe/Amsterdam**.\nDefaults to the time zone of the balance platform if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
      "type": "string"
    }
  },
  "required": [
    "legalEntityId"
  ]
}