User

User (Model)

address_line_1
Type: string
address_line_2
Type: string
affiliate_approval_document
Type: object · Document

Document (Model)
- account
  Type: object · Account
  
  Account (Model)
- 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
- deleted_at
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- id
  Type: string
- mime_type
  Type: stringenum
  values
  application/pdf
  image/png
  image/jpeg
  image/webp
- name
  Type: string
- organization
  Type: object · Organization
  
  Organization (Model)
- type
  Type: stringenum
  values
  w9
  ips
  articles_of_incorporation
  board_report
  meeting_minutes
- 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
- url
  Type: string
affiliated_member_firms
Type: array string[]
affiliated_publicly_traded_companies
Type: array string[]
city
Type: string
consent_events
Type: array object[] · ConsentEvent[]
ConsentEvent (Model)
- agreement
  Type: object · Agreement
  
  Agreement (Model)
- 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
- e_signature
  Type: string
- id
  Type: string
- ip_address
  Type: string
- latitude
  Type: number
- location_accuracy
  Type: number
- longitude
  Type: number
- 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
- user
  Type: object · User
  
  User (Model)
- user_agent
  Type: string
country
Type: string · CountryCodeenum nullable

ISO 3166-1 alpha-2 country code
values
- ad
- ae
- af
- ag
- ai
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_card
- driving_licence
- passport
- voter_id
- work_permit
- unknown
identification_verified
Type: boolean
identity_document_back
Type: object · Document

Document (Model)
- account
  Type: object · Account
  
  Account (Model)
- 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
- deleted_at
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- id
  Type: string
- mime_type
  Type: stringenum
  values
  application/pdf
  image/png
  image/jpeg
  image/webp
- name
  Type: string
- organization
  Type: object · Organization
  
  Organization (Model)
- type
  Type: stringenum
  values
  w9
  ips
  articles_of_incorporation
  board_report
  meeting_minutes
- 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
- url
  Type: string
identity_document_front
Type: object · Document

Document (Model)
- account
  Type: object · Account
  
  Account (Model)
- 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
- deleted_at
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- id
  Type: string
- mime_type
  Type: stringenum
  values
  application/pdf
  image/png
  image/jpeg
  image/webp
- name
  Type: string
- organization
  Type: object · Organization
  
  Organization (Model)
- type
  Type: stringenum
  values
  w9
  ips
  articles_of_incorporation
  board_report
  meeting_minutes
- 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
- url
  Type: string
ig_role
Type: stringenum
values
- admin
- viewer
- null
investment_experience
Type: stringenum
values
- none
- limited
- good
- extensive
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: array string[] · CountryCode[]enum
values
- ad
- ae
- af
- ag
- ai
- Type: string · CountryCodeenum
  
  ISO 3166-1 alpha-2 country code
  
  values
  ad
  ae
  af
  ag
  ai
negative_news
Type: string
notification_preferences
Type: array object[] · UserNotificationPreference[]
UserNotificationPreference (Model)
- cash_donation_received
  Type: boolean
- 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
- crypto_donation_received
  Type: boolean
- id
  Type: string
- stock_donation_pledged
  Type: boolean
- stock_donation_received
  Type: boolean
- type
  Type: stringenum
  values
  email
  sms
  apns
  gcm
- 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
- user
  Type: object · User
  
  User (Model)
organizations
Type: array object[] · Organization[]
Organization (Model)
- accounts
  Type: array object[] · Account[]
  
  Account (Model)
- address_line_1
  Type: string
- address_line_2
  Type: string
- advisor
  Type: object · Advisor
  
  Advisor (Model)
- annual_income
  Type: stringenum
  values
  under_25k
  from_25k_to_50k
  from_50k_to_100k
  from_100k_to_200k
  from_200k_to_300k
  from_300k_to_500k
  from_500k_to_1200k
  over_1200k
- anticipated_crypto_volume
  Type: stringenum
  values
  less_than_5k
  5k_to_10k
  10k_to_100k
  100k_to_500k
  500k_to_1m
  over_1m
  null
- articles_of_incorporation
  Type: object · Document
  
  Document (Model)
- balance
  Type: number
- board_approval_agenda
  Type: string
- board_approval_attendees
  Type: string
- board_approved_account_at
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- board_resolution_consent_event
  Type: object · ConsentEvent
  
  ConsentEvent (Model)
- board_resolution_minutes
  Type: object · Document
  
  Document (Model)
- board_secretary_email
  Type: string
- board_secretary_first_name
  Type: string
- board_secretary_last_name
  Type: string
- board_secretary_title
  Type: string
- brand_color
  Type: string
- campaigns
  Type: array object[] · Campaign[]
  
  Campaign (Model)
- capabilities
  Type: object · Capabilities
  
  Capabilities (Interface)
- cash_balance
  Type: number
- city
  Type: string
- corporate_bylaws
  Type: object · Document
  
  Document (Model)
- country
  Type: string · CountryCodeenum nullable
  
  ISO 3166-1 alpha-2 country code
  
  values
  ad
  ae
  af
  ag
  ai
- 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
- crypto_consent_event
  Type: object · ConsentEvent
  
  ConsentEvent (Model)
- documents
  Type: array object[] · Document[]
  
  Document (Model)
- doing_business_as
  Type: array string[]
- donations
  Type: array object[] · Donation[]
  
  Donation (Model)
- donor_address_requirement_asset_threshold
  Type: number
- donor_address_requirement_threshold
  Type: number
- donor_base
  Type: array string[]enum
  values
  us_individuals
  us_corporations
  us_government_grants
  foreign_government_grants
  foreign_individuals
  foreign_corporations
- equities_balance
  Type: number
- exemption_type
  Type: stringenum
  values
  501c1
  501c2
  501c3
  501c4
  501c5
- external_accounts
  Type: array object[] · ExternalAccount[]
  
  ExternalAccount (Model)
- foreign_bank_us_agent
  Type: string
- id
  Type: string
- incorporation_country
  Type: string · CountryCodeenum nullable
  
  ISO 3166-1 alpha-2 country code
  
  values
  ad
  ae
  af
  ag
  ai
- incorporation_date
  Type: stringFormat: date-time
  
  the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- incorporation_province
  Type: string
- invitations
  Type: array object[] · Invitation[]
  
  Invitation (Model)
- irs_data
  Type: object · IrsDatum
  
  IrsDatum (Model)
- irs_determination
  Type: object · Document
  
  Document (Model)
- is_foreign_bank_maintained
  Type: boolean
- legal_name
  Type: string
- liquid_net_worth
  Type: stringenum
  values
  under_50k
  from_50k_to_100k
  from_100k_to_200k
  from_200k_to_500k
  from_500k_to_1m
  from_1m_to_5m
  over_5m
- logo
  Type: object · Document
  
  Document (Model)
- major_donors
  Type: array object[] · MajorDonors[]
  
  MajorDonors (Interface)
- mission
  Type: string
- name
  Type: string
- negative_news
  Type: string
- net_worth
  Type: stringenum
  values
  under_50k
  from_50k_to_100k
  from_100k_to_200k
  from_200k_to_500k
  from_500k_to_1m
  from_1m_to_5m
  over_5m
- operating_countries
  Type: array · CountryCodeNullable[]
- organization_integrations
  Type: array object[] · OrganizationIntegration[]
  
  OrganizationIntegration (Model)
- phone
  Type: string
- politically_exposed_people
  Type: array object[] · PoliticallyExposedPeople[]
  
  PoliticallyExposedPeople (Interface)
- postal_code
  Type: string
- province
  Type: string
- structure
  Type: stringenum
  values
  trust
  corporation
  limited_liability_company
- tax_id
  Type: string
- 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
- url
  Type: string
- users
  Type: array object[] · User[]
  
  User (Model)
- w_9
  Type: object · Document
  
  Document (Model)
- webhooks
  Type: array object[] · Webhook[]
  
  Webhook (Model)
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: object · PoliticalExposure

PoliticalExposure (Interface)
- immediateFamily
  Type: array string[]
- organizationName
  Type: string
postal_code
Type: string
privileged_donor_accounts
Type: array object[] · Account[]
Account (Model)
- account_number
  Type: string
- account_type
  Type: stringenum
  values
  reserve
  growth
  endowment
  donations_only
- accounts
  Type: array object[] · ExternalAccount[]
  
  ExternalAccount (Model)
- async_close_this
  Type: object · Account
  
  Account (Model)
- aum_fee
  Type: number
- balance
  Type: number
- cash_balance
  Type: number
- consent_event
  Type: object · ConsentEvent
  
  ConsentEvent (Model)
- 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
- deposits
  Type: array object[] · Deposit[]
  
  Deposit (Model)
- disbursement_annual_percentage
  Type: number
- disbursement_frequency
  Type: string
- documents
  Type: array object[] · Document[]
  
  Document (Model)
- equities_balance
  Type: number
- id
  Type: string
- initial_deposit_amount
  Type: number
- ips_document
  Type: object · Document
  
  Document (Model)
- name
  Type: string
- orders
  Type: array object[] · Order[]
  
  Order (Model)
- organization
  Type: object · Organization
  
  Organization (Model)
- portfolio
  Type: object · Portfolio
  
  Portfolio (Model)
- positions
  Type: array object[] · PositionResponse[]
  
  PositionResponse (Interface)
- privileged_donor_users
  Type: array object[] · User[]
  
  User (Model)
- status
  Type: stringenum
  values
  draft
  ready_for_ig_review
  pending_apex
  active
  pending_closure
  closed
- transactions
  Type: array object[] · Transaction[]
  
  Transaction (Model)
- transfers
  Type: array object[] · AccountTransfer[]
  
  AccountTransfer (Model)
- 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
- withdrawals
  Type: array object[] · Withdrawal[]
  
  Withdrawal (Model)
province
Type: string
residency_status
Type: stringenum
values
- us_permanent_resident
- us_temporary_resident
- us_non_resident
tax_id
Type: string
tax_id_type
Type: stringenum
values
- itin
- ssn
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