User

User (Model)

  • address_line_1
    Type: string
  • address_line_2
    Type: string
  • affiliate_approval_document
    Type:

    Document (Model)

    Properties: 10
  • affiliated_member_firms
    Type: array of string
  • affiliated_publicly_traded_companies
    Type: array of string
  • city
    Type: string
  • consent_events
    Type:
    Properties: 11
  • country
    Type: enumnullable

    ISO 3166-1 alpha-2 country code

    values
    • ad
    • ae
    • af
    • ag
    • ai
    • al
    • am
    • ao
  • created_at
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • date_of_birth
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • email
    Type: stringFormat: email
  • email_verified_at
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • first_name
    Type: string
  • full_name
    Type: string
  • id
    Type: string
  • identification_type
    Type: stringenum
    values
    national_identity_carddriving_licencepassportvoter_idwork_permitunknown
  • identification_verified
    Type: boolean
  • identity_document_back
    Type:

    Document (Model)

    Properties: 10
  • identity_document_front
    Type:

    Document (Model)

    Properties: 10
  • ig_role
    Type: "admin" or "viewer" or "null"enum
  • investment_experience
    Type: stringenum
    values
    nonelimitedgoodextensive
  • is_super_admin
    Type: boolean
  • last_name
    Type: string
  • legal_first_name
    Type: string
  • legal_full_name
    Type: string
  • legal_last_name
    Type: string
  • legal_middle_name
    Type: string
  • nationalities
    Type: enum
  • negative_news
    Type: string
  • notification_preferences
    Type:
    Properties: 9
  • organizations
    Type:
    Properties: 65
  • phone
    Type: string
  • pii_confirmed_at
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • political_exposure
    Type:

    PoliticalExposure (Interface)

    Properties: 2
  • postal_code
    Type: string
  • privileged_donor_accounts
    Type:
    Properties: 28
  • province
    Type: string
  • residency_status
    Type: "us_permanent_resident" or "us_temporary_resident" or "us_non_resident"enum
  • tax_id
    Type: string
  • tax_id_type
    Type: "itin" or "ssn"enum
  • updated_at
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z