Adyen · Schema

ShareholderContact

ShareholderContact schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name	Type	Description
address	object	The address of the person.
email	string	The e-mail address of the person.
fullPhoneNumber	string	The phone number of the person provided as a single string. It will be handled as a landline phone. Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"
jobTitle	string	Job title of the person. Required when the `shareholderType` is Controller. Example values: Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, President, **
name	object	The name of the person.
personalData	object	Contains information about the person.
phoneNumber	object	The phone number of the person.
shareholderCode	string	The unique identifier (UUID) of the shareholder entry. >**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created
shareholderReference	string	Your reference for the shareholder entry.
shareholderType	string	Specifies how the person is associated with the account holder. Possible values: * Owner: Individuals who directly or indirectly own 25% or more of a company. * Controller: Individuals who are
webAddress	string	The URL of the person's website.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/notifications-shareholder-contact-schema.json",
  "title": "ShareholderContact",
  "description": "ShareholderContact schema from Adyen API",
  "type": "object",
  "properties": {
    "address": {
      "description": "The address of the person.",
      "$ref": "#/components/schemas/ViasAddress"
    },
    "email": {
      "description": "The e-mail address of the person.",
      "type": "string"
    },
    "fullPhoneNumber": {
      "description": "The phone number of the person provided as a single string.  It will be handled as a landline phone.\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"",
      "type": "string"
    },
    "jobTitle": {
      "description": "Job title of the person. Required when the `shareholderType` is **Controller**.\n\nExample values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.",
      "type": "string"
    },
    "name": {
      "description": "The name of the person.",
      "$ref": "#/components/schemas/ViasName"
    },
    "personalData": {
      "description": "Contains information about the person.",
      "$ref": "#/components/schemas/ViasPersonalData"
    },
    "phoneNumber": {
      "description": "The phone number of the person.",
      "$ref": "#/components/schemas/ViasPhoneNumber"
    },
    "shareholderCode": {
      "description": "The unique identifier (UUID) of the shareholder entry.\n>**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**\n\n>**If, during an Account Holder create request, a UUID is provided, the creation of Account Holder will fail with a validation Error..**\n\n>**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**\n\n>**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**\n",
      "type": "string"
    },
    "shareholderReference": {
      "x-addedInVersion": "5",
      "description": "Your reference for the shareholder entry.",
      "type": "string"
    },
    "shareholderType": {
      "description": "Specifies how the person is associated with the account holder. \n\nPossible values: \n\n* **Owner**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Controller**: Individuals who are members of senior management staff responsible for managing a company or organization.",
      "enum": [
        "Controller",
        "Owner",
        "Signatory"
      ],
      "type": "string"
    },
    "webAddress": {
      "description": "The URL of the person's website.",
      "type": "string"
    }
  }
}