GetInvestorsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-get-investors-response-schema.json",
  "title": "GetInvestorsResponse",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-investors-api-openapi.yml#/components/schemas/Get-Investors-Response",
  "type": "object",
  "properties": {
    "fundManagerId": {
      "title": "Fund Manager ID",
      "type": "string",
      "description": "Provides the unique identifier for Fund Manager",
      "maxLength": 32
    },
    "investors": {
      "title": "Investors",
      "type": "array",
      "items": {
        "$ref": "#/$defs/Investor"
      }
    }
  },
  "additionalProperties": false,
  "$defs": {
    "Investor": {
      "title": "Investor",
      "type": "object",
      "properties": {
        "id": {
          "title": "Investor ID",
          "description": "Provides the unique identifier for Investor.",
          "type": "string",
          "maxLength": 32
        },
        "type": {
          "title": "Investor Type",
          "description": "Indicates the Investor type i.e. Individual, Institutional.",
          "type": "string",
          "maxLength": 32,
          "enum": [
            "Individual",
            "Institutional"
          ]
        },
        "name": {
          "title": "Investor Name",
          "description": "A party refers to an individual, institution, or entity involved in a financial transaction, agreement, or contractual relationship. In banking, parties can include account holders, investors, banks, fund managers, and regulatory bodies. Each party has defined roles, rights, and responsibilities.",
          "type": "string",
          "maxLength": 256
        },
        "firstName": {
          "title": "Investor First Name",
          "description": "The individual investor's first name(s).",
          "type": "string",
          "maxLength": 32
        },
        "middleName": {
          "title": "Investor Middle Name",
          "description": "The individual investor's middle name.",
          "type": "string",
          "maxLength": 32
        },
        "lastName": {
          "title": "Investor Last Name",
          "description": "The individual investor's surname.",
          "type": "string",
          "maxLength": 32
        },
        "title": {
          "title": "Title",
          "description": "The individual investor's Title.",
          "type": "string",
          "maxLength": 32
        },
        "status": {
          "title": "Investor Status",
          "description": "Indicated whether an investor is Active, Inactive or Closed.",
          "type": "string",
          "enum": [
            "Active",
            "Inactive",
            "Closed"
          ]
        },
        "registerAddressLine1": {
          "title": "Investor Register Address Line 1",
          "description": "Register Address Line 1.",
          "type": "string",
          "maxLength": 200
        },
        "registerAddressLine2": {
          "title": "Investor Register Address Line 2",
          "description": "Register Address Line 2.",
          "type": "string",
          "maxLength": 200
        },
        "registerAddressLine3": {
          "title": "Investor Register Address Line 3",
          "description": "Register Address Line 3.",
          "type": "string",
          "maxLength": 200
        },
        "registerAddressLine4": {
          "title": "Investor Register Address Line 4",
          "description": "Register Address Line 4.",
          "type": "string",
          "maxLength": 200
        },
        "registerAddressLine5": {
          "title": "Investor Register Address Line 5",
          "description": "Register Address Line 5.",
          "type": "string",
          "maxLength": 200
        },
        "registerAddressTown": {
          "title": "Investor Register Address Town",
          "description": "Register Address Town.",
          "type": "string",
          "maxLength": 200
        },
        "registerAddressPostCode": {
          "title": "Investor Register Address Post Code",
          "description": "Register Address Postcode.",
          "type": "string",
          "maxLength": 16
        },
        "registerAddressCountry": {
          "title": "Investor Register Address Country",
          "description": "Register Address Country, in ISO3166 alpha-3.",
          "type": "string",
          "maxLength": 32
        },
        "correspondenceAddressLine1": {
          "title": "Investor Correspondence Address Line 1",
          "description": "Correspondence Address Line 1.",
          "type": "string",
          "maxLength": 200
        },
        "correspondenceAddressLine2": {
          "title": "Investor Correspondence Address Line 2",
          "description": "Correspondence Address Line 2.",
          "type": "string",
          "maxLength": 200
        },
        "correspondenceAddressLine3": {
          "title": "Investor Correspondence Address Line 3",
          "description": "Correspondence Address Line 3.",
          "type": "string",
          "maxLength": 200
        },
        "correspondenceAddressLine4": {
          "title": "Investor Correspondence Address Line 4",
          "description": "Correspondence Address Line 4.",
          "type": "string",
          "maxLength": 200
        },
        "correspondenceAddressLine5": {
          "title": "Investor Correspondence Address Line 5",
          "description": "Correspondence Address Line 5.",
          "type": "string",
          "maxLength": 200
        },
        "correspondenceAddressTown": {
          "title": "Investor Correspondence Address Town",
          "description": "Correspondence Address Town.",
          "type": "string",
          "maxLength": 200
        },
        "correspondenceAddressPostCode": {
          "title": "Investor Correspondence Address Post Code",
          "description": "Correspondence Address Postcode.",
          "type": "string",
          "maxLength": 16
        },
        "correspondenceAddressCountry": {
          "title": "Investor Correspondence Address Country",
          "description": "Correspondence Address County, in ISO3166 alpha-3.1.",
          "type": "string",
          "maxLength": 32
        },
        "emailAddress": {
          "title": "Email Address",
          "description": "The Investor Email address.",
          "type": "string",
          "maxLength": 256
        },
        "amlStatus": {
          "title": "AML Status",
          "description": "Indicates the AML compliancy status of the Investor.",
          "type": "string",
          "enum": [
            "Compliant",
            "Non-Compliant"
          ]
        },
        "riskLevel": {
          "title": "Investor Risk Level",
          "description": "The Risk Level refers to a classification or categorization assigned to a party (individual or organization) based on their assessed level of risk in the context of financial transactions, regulatory compliance, or business relationships. This risk level helps financial institutions evaluate and manage potential risks associated with the party, such as fraud, money laundering, or credit risk.",
          "type": "string",
          "enum": [
            "High",
            "Medium",
            "Low"
          ]
        },
        "legalEntityType": {
          "title": "Legal Entity Type",
          "description": "Defines the type of legal entity of the investor.",
          "type": "string",
          "enum": [
            "Individual",
            "Corporate",
            "Financial Institution",
            "Trust",
            "Foundation",
            "Investment Fund",
            "Pension Scheme",
            "Public Body",
            "Other Legal Arrangements"
          ]
        },
        "fullDealingRestrictionsIndicator": {
          "title": "Full Dealing Restrictions Indicator",
          "description": "Indicates if all transactions are blocked for an Investor across all their accounts.",
          "type": "boolean"
        },
        "purchaseRestrictionsIndicator": {
          "title": "Purchase Restrictions Indicator",
          "description": "Indicates if only purchase type transactions are blocked across all their accounts.",
          "type": "boolean"
        },
        "redemptionRestrictionsIndicator": {
          "title": "Redemption Restrictions Indicator",
          "description": "Indicates if only redemption type transactions are blocked across all their accounts.",
          "type": "boolean"
        },
        "transferInRestrictionsIndicator": {
          "title": "Transfer In Restrictions Indicator",
          "description": "Indicates if only transfer in type transactions are blocked across all their accounts.",
          "type": "boolean"
        },
        "transferOutRestrictionsIndicator": {
          "title": "Transfer Out Restrictions Indicator",
          "description": "Indicates if only transfer out type transactions are blocked across all their accounts.",
          "type": "boolean"
        },
        "exchangeInRestrictionsIndicator": {
          "title": "Exchange In Restrictions Indicator",
          "description": "Indicates if only exchange in type transactions are blocked across all their accounts.",
          "type": "boolean"
        },
        "exchangeOutRestrictionsIndicator": {
          "title": "Exchange Out Restrictions Indicator",
          "description": "Indicates if only exchange out type transactions are blocked across all their accounts.",
          "type": "boolean"
        },
        "settlementRestrictionsIndicator": {
          "title": "Settlement Restrictions Indicator",
          "description": " Indicates if only settlement type transactions are blocked.",
          "type": "boolean"
        },
        "activationDate": {
          "title": "Activation Date",
          "description": "The Party Activation Date refers to the date on which a party (individual or organization) becomes active or authorized to participate in financial transactions or activities .within a specific system, account, or service. This date marks the start of the party's operational or transactional relationship.",
          "type": "string",
          "format": "date"
        },
        "deactivationDate": {
          "title": "Deactivation Date",
          "description": "The Party Deactivation Date refers to the date on which a party (individual or organization) is no longer authorized or active to participate in financial transactions or activities within a specific system, account, or service. This date marks the end of the party's operational or transactional relationship.",
          "type": "string",
          "format": "date"
        },
        "birthDate": {
          "title": "Birth Date",
          "description": "Individual investor's Date of Birth.",
          "type": "string",
          "format": "date"
        },
        "countryOfBirth": {
          "title": "Country Of Birth",
          "description": "Individual investor's Country of Birth, in ISO3166 alpha-3.",
          "type": "string",
          "maxLength": 32
        },
        "cityOfBirth": {
          "title": "City Of Birth",
          "description": "Individual investor's City of Birth.",
          "type": "string",
          "maxLength": 32
        },
        "deceasedStatus": {
          "title": "Deceased Status",
          "description": "Indicates the deceased status of an individual investor.",
          "type": "string",
          "enum": [
            "Alive",
            "Deceased",
            "Deceased Pending"
          ]
        },
        "deathDate": {
          "title": "Death Date",
          "description": "The individual investor's date of death.",
          "type": "string",
          "format": "date"
        },
        "deathNotificationDate": {
          "title": "Death Notification Date",
          "description": "The individual investor's date of death notification date i.e. the date on which Citi have been advised of the death of the investor prior to Citi receiving the formal documents that allow Citi to change the Deceased Status of the Investor.",
          "type": "string",
          "format": "date"
        },
        "additionalSupportRequiredFlag": {
          "title": "Additional Support Required Flag",
          "description": "Indicates if additional support is required for this Investor.",
          "type": "boolean"
        },
        "additionalSupportEffectiveDate": {
          "title": "Additional Support Effective Date",
          "description": "Date from when additional support began.",
          "type": "string",
          "format": "date"
        },
        "additionalSupportIndicator": {
          "title": "Additional Support Indicator",
          "description": "Indicates the type of additional support.",
          "type": "string",
          "maxLength": 32,
          "enum": [
            "Assistive Technology Guidance / Technical Assistance",
            "Potential Move to in-house",
            "Deviation"
          ]
        },
        "countryOfTaxResidency": {
          "title": "Country Of Tax Residency",
          "description": "The individual investor's Country of Tax Residence, in ISO3166 alpha-3.",
          "type": "string",
          "maxLength": 32
        },
        "crsClassification": {
          "title": "CRS Classification",
          "description": "The CRS Classification to be applied to the Investor. Used to drive downstream CRS reporting as certain classifications are exempt from reporting.",
          "type": "string",
          "maxLength": 32
        },
        "crsSelfCertReceived": {
          "title": "CRS Self-Cert Received",
          "description": "The CRS Classification to be applied to the Investor. Used to drive downstream CRS reporting as certain classifications are exempt from reporting.",
          "type": "boolean"
        },
        "crsPreExistingClient": {
          "title": "CRS Pre-Existing Client",
          "description": "Indicates if the investor is a pre-existing entity or not from the view of CRS reporting guidelines. Can only apply to non-Individual type Investors.",
          "type": "boolean"
        },
        "crsUndocumented": {
          "title": "CRS Undocumented",
          "description": "Indicates if the investor is a undocumented or not from the view of CRS reporting guidelines.",
          "type": "boolean"
        },
        "crsDormantIndicator": {
          "title": "CRS Dormant Indicator",
          "description": "Indicates if the investor is a dormant or not from the view of CRS reporting guidelines.",
          "type": "boolean"
        },
        "gdprObfuscationStatus": {
          "title": "GDPR Obfuscation Status",
          "description": "The Obfuscation Status Id refers to a unique identifier or code that indicates whether a party's details (such as name, address, or other sensitive information) have been intentionally obfuscated or masked. This is typically done to protect privacy, comply with data protection regulations, or meet specific operational requirements.",
          "type": "string",
          "maxLength": 32,
          "enum": [
            "Obfuscated",
            "Not Obfuscated",
            "To Be Obfuscated"
          ]
        },
        "gdprObfuscationExclusion": {
          "title": "GDPR Obfuscation Exclusion",
          "description": "The Excluded From Obfuscation Flag is a indicator that specifies whether a party's details (such as name, address, or other sensitive information) are exempt from obfuscation or masking. This flag ensures that certain parties' information remains fully visible, even in scenarios where obfuscation is applied to other parties.",
          "type": "string",
          "maxLength": 32
        },
        "fatcaClassification": {
          "title": "FATCA Classification",
          "description": "The FATCA entity classification ID e.g. FFI, etc.",
          "type": "string",
          "maxLength": 32,
          "enum": [
            "Active NFFE",
            "Affiliate of publicly traded NFFE",
            "Certified DC FFI - other",
            "Certified DC FFI/sponsored entity",
            "Certified deemed-compliant FFI with only low-value accounts",
            "Certified deemed-compliant non-profit organization",
            "Entity wholly owned by exempt beneficial owners",
            "Excepted Foreign Financial Institution",
            "Excepted inter-affiliate FFI",
            "Excepted NFFE - other",
            "Excepted nonfinancial holding company",
            "Excepted Territory NFFE",
            "Exempt beneficial owner",
            "Individual",
            "Nonparticipating FFI",
            "Nonparticipating FFI with exempt beneficial owners",
            "Non-reporting IGA FFI",
            "Not applicable - merchant submitting this form solely",
            "Participating FFI",
            "Participating FFI - other",
            "Participating FFI reporting model 2 FFI",
            "Passive NFFE reported FFI",
            "Passive NFFE with no substantial U.S. owners",
            "Passive NFFE with substantial U.S. owners",
            "Passive NFFE/no substantial US owner",
            "Publicly traded NFFE",
            "Register DC FFI reporting model 1 FFI",
            "Registered DC FFI - other",
            "Registered DC FFI - sponsored entity",
            "Registered deemed-compliant FFI",
            "Section 501 entities",
            "Sponsored direct reporting NFFE",
            "Territory FI not treated as US person",
            "Territory financial institution",
            "Undocumented preexisting obligation",
            "Unknown recipient",
            "US reportable account"
          ]
        },
        "fatcaSelfCertReceived": {
          "title": "FATCA Self-Cert Received",
          "description": "Indicates if a self-cert has been received from the Investor for FATCA purposes.",
          "type": "boolean"
        },
        "fatcaExempt": {
          "title": "FATCA Exempt",
          "description": "Indicates if an Investor is except from the FATCA reporting requirements.",
          "type": "boolean"
        },
        "tin": {
          "title": "TIN",
          "description": "The investor's tax identification number.",
          "type": "string",
          "maxLength": 32
        },
        "giin": {
          "title": "GIIN",
          "description": "The investor's Global Intermediary Identification Number.",
          "type": "string",
          "maxLength": 32
        },
        "nonDigitalInvestor": {
          "title": "Non-Digital Investor",
          "description": "Indicates if the Investor is non-digital.",
          "type": "string",
          "maxLength": 32
        },
        "professionalFlag": {
          "title": "Professional Flag",
          "description": "Flag on whether Investor is deemed a professional.",
          "type": "string",
          "maxLength": 32
        },
        "investorDecisionMakerCountry": {
          "title": "Investor Decision Maker Country",
          "description": "The Investor Decision Maker Country, in ISO3166 alpha-3..",
          "type": "string",
          "maxLength": 32
        },
        "kycId": {
          "title": "KYC ID",
          "description": "KYC ID.",
          "type": "integer"
        },
        "accountIds": {
          "title": "Account IDs",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    }
  }
}