User Types & Statuses

  • Every User object has a "type" that indicates its primary purpose
  • In most cases, you will create INDIVIDUAL_TRADER-type Users

User Type

Enum

Description

Individual Trader

INDIVIDUAL_TRADER

Customers allowed to open a brokerage account, or a direct activity in someone else's account

Custodial

CUSTODIAL

Users allowed read-only access to an account, which is managed by someone else. Typically used for under-18 customers setup by a parent.

  • Each user has a current status
  • The below table explains the different statuses and when it's appropriate to use them

User Status

Enum

Description

Pending

"PENDING"

User is pending approval

Approved

"APPROVED"

User approved

Revoked

"REVOKED"

User rejected

Closed

"CLOSED"

User closed