Adyen · Schema

LegalArrangementEntityDetail

PaymentsFinancial ServicesFintech

Properties

Name Type Description
address object The address of the entity.
businessDetails object Required when creating an entity with `legalEntityType` **Business**, **NonProfit**, **PublicCompany**, or **Partnership**.
email string The e-mail address of the entity.
fullPhoneNumber string The phone number of the contact 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"
individualDetails object Required when creating an entity with `legalEntityType` **Individual**.
legalArrangementEntityCode string Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity. Use only when updating an account holder. If you include this
legalArrangementEntityReference string Your reference for the legal arrangement entity.
legalArrangementMembers array An array containing the roles of the entity in the legal arrangement. The possible values depend on the legal arrangement `type`. - For `type` **Association**: **ControllingPerson** and **Shareholder*
legalEntityType string The legal entity type. Possible values: **Business**, **Individual**, **NonProfit**, **PublicCompany**, or **Partnership**.
phoneNumber object The phone number of the entity.
webAddress string The URL of the website of the contact.
View JSON Schema on GitHub

JSON Schema

adyen-legalarrangemententitydetail-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LegalArrangementEntityDetail",
  "title": "LegalArrangementEntityDetail",
  "properties": {
    "address": {
      "description": "The address of the entity.",
      "$ref": "#/components/schemas/ViasAddress"
    },
    "businessDetails": {
      "description": "Required when creating an entity with `legalEntityType` **Business**, **NonProfit**, **PublicCompany**, or **Partnership**.",
      "$ref": "#/components/schemas/BusinessDetails"
    },
    "email": {
      "description": "The e-mail address of the entity.",
      "type": "string"
    },
    "fullPhoneNumber": {
      "description": "The phone number of the contact provided as a single string.  It will be handled as a landline phone.\n**Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"",
      "type": "string"
    },
    "individualDetails": {
      "description": "Required when creating an entity with `legalEntityType` **Individual**.",
      "$ref": "#/components/schemas/IndividualDetails"
    },
    "legalArrangementEntityCode": {
      "description": "Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity.\nUse only when updating an account holder. If you include this field when creating an account holder, the request will fail.",
      "type": "string"
    },
    "legalArrangementEntityReference": {
      "description": "Your reference for the legal arrangement entity.",
      "type": "string"
    },
    "legalArrangementMembers": {
      "description": "An array containing the roles of the entity in the legal arrangement.\n\nThe possible values depend on the legal arrangement `type`.\n\n- For `type` **Association**: **ControllingPerson** and **Shareholder**.\n\n- For `type` **Partnership**: **Partner** and **Shareholder**.\n\n- For `type` **Trust**: **Trustee**, **Settlor**, **Protector**, **Beneficiary**,  and **Shareholder**.\n\n",
      "items": {
        "enum": [
          "Beneficiary",
          "ControllingPerson",
          "Partner",
          "Protector",
          "Settlor",
          "Shareholder",
          "Trustee"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "legalEntityType": {
      "description": "The legal entity type.\n\nPossible values: **Business**, **Individual**, **NonProfit**, **PublicCompany**, or **Partnership**. ",
      "enum": [
        "Business",
        "Individual",
        "NonProfit",
        "Partnership",
        "PublicCompany"
      ],
      "type": "string"
    },
    "phoneNumber": {
      "description": "The phone number of the entity.",
      "$ref": "#/components/schemas/ViasPhoneNumber"
    },
    "webAddress": {
      "description": "The URL of the website of the contact.",
      "type": "string"
    }
  },
  "type": "object"
}