AccountWithPersonalDetails

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clearstreet8e71/main/json-schema/clearstreet8e71-account-with-personal-details-schema.json",
  "title": "AccountWithPersonalDetails",
  "description": "A trading account enriched with details about the account-holder entity.",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/clearstreet8e71-openapi.yaml#/components/schemas/AccountWithPersonalDetails",
  "allOf": [
    {
      "oneOf": [
        {
          "type": "object",
          "description": "Represents a trading account",
          "required": [
            "id",
            "short_name",
            "full_name",
            "type",
            "subtype",
            "open_date",
            "account_holder_entity_id",
            "account_holder_entity_kind",
            "options_level",
            "status"
          ],
          "properties": {
            "account_holder_entity_id": {
              "type": "integer",
              "format": "int64",
              "description": "The account holder entity identifier"
            },
            "account_holder_entity_kind": {
              "$ref": "#/$defs/AccountHolderEntityKind",
              "description": "Whether the account holder is a natural person or a legal entity."
            },
            "close_date": {
              "type": [
                "string",
                "null"
              ],
              "format": "date",
              "description": "The date the account was closed, if applicable\nWhen a null/undefined value is observed, it indicates it does not apply."
            },
            "full_name": {
              "type": "string",
              "description": "The full legal name of the account"
            },
            "id": {
              "$ref": "#/$defs/i64",
              "description": "The unique identifier for the account"
            },
            "open_date": {
              "type": "string",
              "format": "date",
              "description": "The date the account was opened"
            },
            "options_level": {
              "$ref": "#/$defs/i64",
              "description": "The options level of the account"
            },
            "short_name": {
              "type": "string",
              "description": "The short name of the account"
            },
            "status": {
              "$ref": "#/$defs/AccountStatus",
              "description": "The current status of the account"
            },
            "subtype": {
              "$ref": "#/$defs/AccountSubtype",
              "description": "The sub-type of account"
            },
            "type": {
              "$ref": "#/$defs/AccountType",
              "description": "The type of account"
            }
          }
        }
      ],
      "description": "The core account details"
    },
    {
      "type": "object",
      "properties": {
        "country_of_tax_residency": {
          "type": [
            "string",
            "null"
          ],
          "description": "The country of tax residency of the account-holder entity. `null`\nwhen not on file or entity reference data is unavailable.\nWhen a null/undefined value is observed, it indicates that there is no available data."
        },
        "date_of_birth": {
          "type": [
            "string",
            "null"
          ],
          "format": "date",
          "description": "The date of birth of the account holder's primary contact. `null`\nwhen not on file or entity reference data is unavailable.\nWhen a null/undefined value is observed, it indicates that there is no available data."
        },
        "mailing_address": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/$defs/Address",
              "description": "The mailing address of the account-holder entity. `null` when no\nmailing address is on file or entity reference data is unavailable.\nWhen a null/undefined value is observed, it indicates that there is no available data."
            }
          ]
        },
        "phone_number": {
          "type": [
            "string",
            "null"
          ],
          "description": "The phone number of the account holder's primary contact. `null`\nwhen not on file or entity reference data is unavailable.\nWhen a null/undefined value is observed, it indicates that there is no available data."
        }
      }
    }
  ],
  "$defs": {
    "AccountHolderEntityKind": {
      "type": "string",
      "description": "Whether an account holder is a natural person or a legal entity.",
      "enum": [
        "NATURAL_PERSON",
        "LEGAL_ENTITY",
        "OTHER"
      ]
    },
    "AccountStatus": {
      "type": "string",
      "description": "Account status",
      "enum": [
        "ACTIVE",
        "INACTIVE",
        "CLOSED"
      ]
    },
    "AccountSubtype": {
      "type": "string",
      "description": "Account subtype classification providing more granular categorization",
      "enum": [
        "CASH",
        "MARGIN",
        "OTHER"
      ]
    },
    "AccountType": {
      "type": "string",
      "description": "Account type classification",
      "enum": [
        "CUSTOMER",
        "OTHER"
      ]
    },
    "Address": {
      "type": "object",
      "description": "A postal address.",
      "required": [
        "line1",
        "city",
        "postal_code",
        "country"
      ],
      "properties": {
        "city": {
          "type": "string",
          "description": "City"
        },
        "country": {
          "type": "string",
          "description": "Country"
        },
        "line1": {
          "type": "string",
          "description": "First street address line"
        },
        "line2": {
          "type": [
            "string",
            "null"
          ],
          "description": "Second street address line\nWhen a null/undefined value is observed, it indicates it does not apply."
        },
        "postal_code": {
          "type": "string",
          "description": "Postal code"
        },
        "state": {
          "type": [
            "string",
            "null"
          ],
          "description": "State or province\nWhen a null/undefined value is observed, it indicates it does not apply."
        }
      }
    },
    "i64": {
      "type": "integer",
      "format": "int64"
    }
  }
}