HoldingListData

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wordline/main/json-schema/wordline-holding-list-data-schema.json",
  "title": "HoldingListData",
  "x-generated": "2026-10-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/wordline-holding-api-openapi.yml#/components/schemas/HoldingListData",
  "type": "object",
  "properties": {
    "contractIdentification": {
      "type": "object",
      "properties": {
        "acquirerId": {
          "type": "string",
          "description": "Unique identification of the acquirer, determined by equensWorldline"
        }
      }
    },
    "holdingId": {
      "type": "integer",
      "description": "Unique identification of the holding, determined by equensWorldline",
      "format": "int32"
    },
    "holdingName": {
      "type": "string",
      "description": "Name of the holding"
    },
    "status": {
      "type": "string",
      "description": "The status of this entity. Values [Active]"
    },
    "address": {
      "$ref": "#/$defs/Address"
    },
    "holdingDetailsURI": {
      "type": "string",
      "description": "URI to get the holding details"
    }
  },
  "$defs": {
    "Address": {
      "type": "object",
      "properties": {
        "streetName": {
          "type": "string",
          "description": "Street name and house number of the address. In case of a Dutch address only Street name"
        },
        "houseNumber": {
          "type": "integer",
          "description": "House number. Only used for Dutch addresses",
          "format": "int32"
        },
        "houseAddition": {
          "type": "string",
          "description": "House number addition. Only used for Dutch addresses"
        },
        "postalCode": {
          "type": "string",
          "description": "Postal code of the address"
        },
        "city": {
          "type": "string",
          "description": "City of the address"
        },
        "region": {
          "type": "string",
          "description": "Region of the address. Only applicable for specific countries"
        },
        "countryCode": {
          "type": "string",
          "description": "Country of the address according to ISO 3166-1 (numeric-3)"
        },
        "contactPersonName": {
          "type": "string",
          "description": "Name of the contact person registered with the address"
        },
        "telephoneNumber": {
          "type": "string",
          "description": "Telephone number of contact person registered with the address"
        },
        "email": {
          "type": "string",
          "description": "E-mail address of the contact person registered with the address"
        }
      }
    }
  }
}