---
updatedAt: 2026-05-27T16:57:55.000Z
agentTools:
  projectIndex: https://developer.drivewealth.com/apis/llms.txt
---

# Retrieve User

Retrieves a User details by userID.

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "title": "Core APIs",
    "version": "2026-11-07",
    "contact": {
      "email": "producteng@drivewealth.tech"
    }
  },
  "servers": [
    {
      "url": "https://bo-api.drivewealth.io/back-office",
      "description": "Sandbox (No Real World Financial/Trading Impact)"
    },
    {
      "url": "https://bo-api.drivewealth.net/back-office",
      "description": "Production"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": false,
    "headers": [
      {
        "key": "dw-client-app-key",
        "value": "{{yourAppKey}}"
      }
    ]
  },
  "tags": [
    {
      "name": "Users"
    }
  ],
  "paths": {
    "/users/{userID}": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "Retrieve User",
        "description": "Retrieves a User details by userID.",
        "parameters": [
          {
            "in": "path",
            "name": "userID",
            "schema": {
              "type": "string"
            },
            "required": true,
            "example": "123e4567-e89b-12d3-a456-000000000004",
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nUnique ID of the User to fetch.",
            "x-sensitive": true
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieving a User was Successful.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserObject"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "userID": {
        "type": "string",
        "example": "123e4567-e89b-12d3-a456-000000000004",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nA unique identifier created for each User on DriveWealth's platform.",
        "x-sensitive": true
      },
      "firstName": {
        "type": "string",
        "example": "John",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe first name of the user.",
        "x-sensitive": true
      },
      "lastName": {
        "type": "string",
        "example": "Smith",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe last (family) name of the user.",
        "x-sensitive": true
      },
      "email": {
        "type": "string",
        "example": "john.doe@example.com",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe user's email address.",
        "x-sensitive": true
      },
      "wlpID": {
        "type": "string",
        "example": "TTC",
        "description": "The wlpID is a deep backoffice ID that identifies each partner from each other."
      },
      "walletSettlementProfileID": {
        "type": "string",
        "example": "bank-profile-1",
        "description": "The walletSettlementProfileID is a identifier that denotes a user's wallet settlement profile for eligible partners."
      },
      "parentIBID": {
        "type": "string",
        "example": "123e4567-e89b-12d3-a456-000000000005",
        "description": "The unique identifier of the firm."
      },
      "phoneNumber": {
        "type": "string",
        "example": "18005550100",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe phone number of the user.",
        "x-sensitive": true
      },
      "userTaxIDLastFour": {
        "type": "string",
        "example": "****-4444",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe user's last 4 digits of their national identification number or tax identification number.",
        "x-sensitive": true
      },
      "userCountry": {
        "type": "string",
        "example": "USA",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe user's country.",
        "x-sensitive": true
      },
      "userMaritalStatus": {
        "type": "string",
        "example": "SINGLE",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe marital status of the user.",
        "enum": [
          "SINGLE",
          "DIVORCED",
          "MARRIED",
          "WIDOWED",
          "PARTNER"
        ],
        "x-enumDescriptions": {
          "SINGLE": "Single.",
          "DIVORCED": "Divorced.",
          "MARRIED": "Married.",
          "WIDOWED": "Widowed.",
          "PARTNER": "Domestic partnership."
        },
        "x-sensitive": true
      },
      "userStreet1": {
        "type": "string",
        "example": "123 Main Street",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe user's current street address, where they live.",
        "x-sensitive": true
      },
      "userStreet2": {
        "type": "string",
        "example": "Suite 1000",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe user's additional details of an address i.e. an apartment number.",
        "x-sensitive": true
      },
      "userCity": {
        "type": "string",
        "example": "New York",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe user's current city, where they live.",
        "x-sensitive": true
      },
      "userProvince": {
        "type": "string",
        "example": "NY",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe user's current state/province/territory, where they live.",
        "x-sensitive": true
      },
      "firmName": {
        "type": "string",
        "example": "Tendies Trading Company",
        "description": "The firm name."
      },
      "idIssueDate": {
        "type": "string",
        "example": "2022-12-25",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe date the identification document was issued.",
        "x-sensitive": true
      },
      "idExpiryDate": {
        "type": "string",
        "example": "2022-12-25",
        "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe date the identification document expires.",
        "x-sensitive": true
      },
      "directors": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "example": "Chief Innovation Officer",
            "description": "The title of the director."
          },
          "controlContact": {
            "type": "boolean",
            "example": true,
            "description": "True, if the director has control over the account."
          },
          "institutionalID": {
            "type": "string",
            "example": "123e4567-e89b-12d3-a456-00000000015d",
            "description": "The unique identifier of the institution director should assioacted with.."
          },
          "roles": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "CONTROL_PERSON",
              "enum": [
                "CONTROL_PERSON",
                "BENEFICIAL_OWNER",
                "TRUSTEE",
                "GRANTOR",
                "BENEFICIARY"
              ],
              "description": "The role in which the director serves in the institution.",
              "x-enumDescriptions": {
                "CONTROL_PERSON": "A person with control over the entity.",
                "BENEFICIAL_OWNER": "A beneficial owner of the entity.",
                "TRUSTEE": "A trustee of the entity.",
                "GRANTOR": "A grantor of the entity.",
                "BENEFICIARY": "A beneficiary of the entity."
              }
            }
          },
          "percentage": {
            "type": "number",
            "example": 0.52,
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe percentage of ownership the director has in the institution. Value must be greater than 0 and up to 1 (representing 0-100%), with a maximum of 2 decimal places.",
            "x-sensitive": true
          }
        }
      },
      "UserObject": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/userID"
          },
          "ackSignedWhen": {
            "type": "string",
            "example": "2022-12-11T22:28:21.666Z",
            "description": "The date and time the User signed the digital documents."
          },
          "addressLine1": {
            "$ref": "#/components/schemas/userStreet1"
          },
          "addressLine2": {
            "$ref": "#/components/schemas/userStreet2"
          },
          "city": {
            "$ref": "#/components/schemas/userCity"
          },
          "countryID": {
            "$ref": "#/components/schemas/userCountry"
          },
          "displayName": {
            "type": "string",
            "example": "JDoe",
            "description": "The User's display name. *By default this is firstName inital followed by last name.*"
          },
          "dob": {
            "type": "string",
            "example": "2000-12-3",
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe User's date of birth in this format YYYY-MM-DD",
            "x-sensitive": true
          },
          "dateOfDeath": {
            "type": "string",
            "example": "2025-12-04",
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe User's date of death in YYYY-MM-DD format.",
            "x-sensitive": true
          },
          "email": {
            "$ref": "#/components/schemas/email"
          },
          "firstName": {
            "$ref": "#/components/schemas/firstName"
          },
          "lastName": {
            "$ref": "#/components/schemas/lastName"
          },
          "parentIB": {
            "type": "object",
            "properties": {
              "id": {
                "$ref": "#/components/schemas/parentIBID"
              },
              "name": {
                "$ref": "#/components/schemas/firmName"
              }
            }
          },
          "phone": {
            "$ref": "#/components/schemas/phoneNumber"
          },
          "referralCode": {
            "type": "string",
            "example": "71J000",
            "description": "The assiocated referral program assiocated to the User."
          },
          "stateProvince": {
            "$ref": "#/components/schemas/userProvince"
          },
          "wlpID": {
            "$ref": "#/components/schemas/wlpID"
          },
          "walletSettlementProfileID": {
            "$ref": "#/components/schemas/walletSettlementProfileID"
          },
          "zipPostalCode": {
            "type": "string",
            "example": 10001,
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe User's current postal code (zip code).",
            "x-sensitive": true
          },
          "idNo": {
            "$ref": "#/components/schemas/userTaxIDLastFour"
          },
          "idIssuingCountry": {
            "$ref": "#/components/schemas/userCountry",
            "description": "The country where the identification was issued."
          },
          "idIssuingProvince": {
            "$ref": "#/components/schemas/userProvince",
            "description": "The state or province where the identification was issued."
          },
          "idIssueDate": {
            "$ref": "#/components/schemas/idIssueDate",
            "description": "The date when the identification was issued in YYYY-MM-DD format.."
          },
          "idExpiryDate": {
            "$ref": "#/components/schemas/idExpiryDate",
            "description": "The date when the identification expires in YYYY-MM-DD format.."
          },
          "institutionalDirectorInfo": {
            "type": "object",
            "description": "A map of institutional director information, where keys are director IDs (strings) and values are director details.",
            "additionalProperties": {
              "$ref": "#/components/schemas/directors"
            },
            "example": {
              "123e4567-e89b-12d3-a456-00000000015f": {
                "title": "Chief Innovation Officer",
                "controlContact": false,
                "institutionalID": "123e4567-e89b-12d3-a456-00000000015f",
                "percentage": 0.5,
                "roles": [
                  "TRUSTEE",
                  "GRANTOR",
                  "BENEFICIARY"
                ]
              }
            }
          },
          "status": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "PENDING",
                "description": "The user's current know your User (KYC) status.",
                "enum": [
                  "PENDING",
                  "APPROVED"
                ],
                "x-enumDescriptions": {
                  "PENDING": "The user is pending approval.",
                  "APPROVED": "The user has been approved."
                }
              },
              "description": {
                "type": "string",
                "example": "User is pending approval.",
                "description": "A custom description of the User's status."
              }
            }
          },
          "userType": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "INDIVIDUAL_TRADER",
                "description": "The name that describes the type of User.",
                "enum": [
                  "INDIVIDUAL_TRADER",
                  "CUSTODIAL"
                ],
                "x-enumDescriptions": {
                  "INDIVIDUAL_TRADER": "An individual retail trader.",
                  "CUSTODIAL": "A custodian onboarding an account on behalf of a minor."
                }
              },
              "description": {
                "type": "string",
                "example": "Individual Trader",
                "description": "A custom description of the User type."
              }
            }
          },
          "usCitizen": {
            "type": "boolean",
            "example": true,
            "description": "True, if a the User is a United States Citizen"
          },
          "updatedWhen": {
            "type": "string",
            "example": "2022-12-11T22:28:21.810Z",
            "description": "The updatedWhen is the last date and time the User was updated."
          },
          "brandAmbassador": {
            "type": "boolean",
            "example": false
          },
          "employerBusiness": {
            "type": "string",
            "example": "FINANCE",
            "description": "The User's current employer type."
          },
          "employmentStatus": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "EMPLOYED",
                "description": "The User's current employment status."
              },
              "description": {
                "type": "string",
                "example": "Employed",
                "description": "A description of the employment status."
              }
            }
          },
          "citizenship": {
            "$ref": "#/components/schemas/userCountry"
          },
          "createdWhen": {
            "type": "string",
            "example": "2022-12-11T22:28:21.810Z",
            "description": "The createdWhen is the date and time the User was created."
          },
          "marginDefault": {
            "type": "number",
            "example": 0
          },
          "maritalStatus": {
            "type": "object",
            "properties": {
              "name": {
                "$ref": "#/components/schemas/userMaritalStatus"
              },
              "description": {
                "type": "string",
                "example": "Single",
                "description": "A description of the marital status of the User."
              }
            },
            "x-sensitive": true,
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)"
          },
          "ackCustomerAgreement": {
            "type": "boolean",
            "example": true,
            "description": "True, if the User accepted DriveWealth's Customer Agreement."
          },
          "ackFindersFee": {
            "type": "boolean",
            "example": false,
            "description": "True, if the User accepted DriveWealth's Finders Fee Agreement."
          },
          "ackForeignFindersFee": {
            "type": "boolean",
            "example": false,
            "description": "True, if the User accepted DriveWealth's Foreign Finders Fee Agreement."
          },
          "ackJointCustomerAgreement": {
            "type": "boolean",
            "example": true,
            "description": "True, if the User accepted DriveWealth's Customer Agreement."
          },
          "ackJointFindersFee": {
            "type": "boolean",
            "example": false,
            "description": "True, if the User has accepted a Joint Finder's Fee Agreement with DriveWealth & the partner."
          },
          "ackJointForeignFindersFee": {
            "type": "boolean",
            "example": false,
            "description": "True, if the User has accepted a Joint Foreign Finder's Fee Agreement with DriveWealth & the partner."
          },
          "ackJointMarketData": {
            "type": "boolean",
            "example": false,
            "description": "True, if the User has accepted a Joint Market Data Agreement with DriveWealth & the partner."
          },
          "ackMarketData": {
            "type": "boolean",
            "example": false,
            "description": "True, if the User has accepted DriveWealth's Market Data Agreement."
          },
          "ackExtendedHoursAgreement": {
            "type": "boolean",
            "example": false,
            "description": "True, if the User has accepted DriveWealth's Extended Hours Agreement."
          },
          "ackOptionsAgreement": {
            "type": "boolean",
            "example": true,
            "description": "True, if the User accepts DriveWealth's Options trading Agreement."
          },
          "dependents": {
            "type": "number",
            "example": 0,
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe amount of children or dependents assiocated with the User.",
            "x-sensitive": true
          },
          "termsOfUse": {
            "type": "boolean",
            "example": true,
            "description": "True, if the User has accepted DriveWealth's Terms of Use Agreement."
          },
          "badPasswordCount": {
            "type": "boolean",
            "example": 0
          },
          "director": {
            "type": "boolean",
            "example": false,
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nTrue, if the User is a director at a public traded company or owns 10% or more of a public company.",
            "x-sensitive": true
          },
          "employerCompany": {
            "type": "string",
            "example": "DriveWealth LLC",
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe name of the User's employer.",
            "x-sensitive": true
          },
          "employerCompanyID": {
            "type": "string",
            "example": "123e4567-e89b-12d3-a456-000000000004",
            "description": "A unique identifier created for each Institution or entity on DriveWealth's platform.*"
          },
          "employerCompanyStartDate": {
            "type": "string",
            "example": "2014-09-29",
            "description": "The User's start date at the employment."
          },
          "employerCompanyEndDate": {
            "type": "string",
            "example": "2022-12-25",
            "description": "The User's end date at the employment."
          },
          "employerIsBroker": {
            "type": "boolean",
            "example": true,
            "description": "True, if the User's employer is a brokerage firm."
          },
          "employmentPosition": {
            "type": "string",
            "example": "ENGINEER",
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe User's current employment job type.",
            "x-sensitive": true
          },
          "employmentYears": {
            "type": "number",
            "example": 0,
            "description": "The amount of years the User has been employed with the employer."
          },
          "jointEmployerIsBroker": {
            "type": "boolean",
            "example": false
          },
          "investmentObjectives": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "CAPITAL_PRESERVATION",
                "description": "The User's current investment objectives. **Deprecated values:** LONG_TERM, INFREQUENT, FREQUENT, ACTIVE_DAILY."
              },
              "description": {
                "type": "string",
                "example": "Capital Preservation",
                "description": "A custom description of the investment objective."
              }
            }
          },
          "investmentExperience": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "YRS_10_",
                "description": "The User's current investment expertise."
              },
              "description": {
                "type": "string",
                "example": "10+ yrs",
                "description": "A custom description of investment expertise."
              }
            }
          },
          "politicallyExposed": {
            "type": "boolean",
            "example": false,
            "description": "True, if the User is politically exposed to another person.\n\n *⚠️ Can be set to 'NULL' if not politically exposed"
          },
          "riskTolerance": {
            "type": "string",
            "example": "HIGH",
            "description": "The User's risk ceiling.",
            "enum": [
              "LOW",
              "MODERATE",
              "SPECULATION",
              "HIGH"
            ],
            "x-enumDescriptions": {
              "LOW": "Low risk tolerance.",
              "MODERATE": "Moderate risk tolerance.",
              "SPECULATION": "Speculative risk tolerance.",
              "HIGH": "High risk tolerance."
            }
          },
          "userNoteQty": {
            "type": "number",
            "example": 0,
            "description": "Total number of notes on the user."
          },
          "validTaxForm": {
            "type": "boolean",
            "example": true,
            "description": "True, if the user has verified/updated tax information."
          },
          "w8received": {
            "type": "string",
            "example": "2026-02-06",
            "description": "The date W8 is received"
          },
          "w8expires": {
            "type": "string",
            "example": "2029-12-31",
            "description": "The date W8 expires"
          },
          "validTaxFormWhen": {
            "type": "string",
            "example": "2022-12-11T22:28:21.810Z",
            "description": "The validTaxForm is the date and time the validTaxForm was changed."
          },
          "taxTreatyWithUS": {
            "type": "boolean",
            "example": true,
            "description": "True, if the user lives in a treaty country and is claiming tax treaty with the United States."
          },
          "taxCountry": {
            "type": "string",
            "example": "AUS",
            "description": "Tax residence country code (ISO 3166-1 alpha-3) on Tax Treaty Benefits with the United States."
          },
          "taxAttestation": {
            "type": "object",
            "properties": {
              "signedBy": {
                "type": "string",
                "example": "123e4567-e89b-12d3-a456-00000000015e",
                "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe user ID of the person who signed the attestation.",
                "x-sensitive": true
              },
              "signedWhen": {
                "type": "string",
                "example": "2022-12-11T22:28:21.810Z",
                "description": "The timestamp when attestation was signed."
              }
            }
          },
          "avatarURL": {
            "type": "string",
            "example": "https://secure.gravatar.com/avatar/00000000000000000000000000000000.jpg",
            "description": "The User's avatar."
          },
          "annualIncomeRange": {
            "type": "string",
            "example": "$0 - $24,999",
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe User's annual income range, in dollar form.",
            "enum": [
              "Unknown",
              "$0 - $24,999",
              "$25,000 - $49,999",
              "$50,000 - $99,999",
              "$100,000 - $199,999",
              "$200,000 - $499,999",
              "$500,000 - $999,999",
              "$1,000,000 - $4,999,999",
              "$5,000,000 - $9,999,999",
              "$10,000,000+"
            ],
            "x-enumDescriptions": {
              "Unknown": "Income range not provided.",
              "$0 - $24,999": "$0 to $24,999.",
              "$25,000 - $49,999": "$25,000 to $49,999.",
              "$50,000 - $99,999": "$50,000 to $99,999.",
              "$100,000 - $199,999": "$100,000 to $199,999.",
              "$200,000 - $499,999": "$200,000 to $499,999.",
              "$500,000 - $999,999": "$500,000 to $999,999.",
              "$1,000,000 - $4,999,999": "$1,000,000 to $4,999,999.",
              "$5,000,000 - $9,999,999": "$5,000,000 to $9,999,999.",
              "$10,000,000+": "$10,000,000 or more."
            },
            "x-sensitive": true
          },
          "ackDisclosureRule14b": {
            "type": "boolean",
            "example": true,
            "description": "True, if the User has accepted DriveWealth's Rule 14b Agreement."
          },
          "ackJointDisclosureRule14b": {
            "type": "boolean",
            "example": false,
            "description": "True, if the User has accepted a Joint Rule 14b Agreement with DriveWealth & the parnter."
          },
          "networthLiquidRange": {
            "type": "string",
            "example": "$0 - $24,999",
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe user's liquid net worth range. The amount of cash or near cash equivalents of the User's net worth.",
            "enum": [
              "Unknown",
              "$0 - $4,999",
              "$5,000 - $24,999",
              "$25,000 - $49,999",
              "$50,000 - $99,999",
              "$100,000 - $199,999",
              "$200,000 - $499,999",
              "$500,000 - $999,999",
              "$1,000,000 - $4,999,999",
              "$5,000,000 - $9,999,999",
              "$10,000,000+"
            ],
            "x-enumDescriptions": {
              "Unknown": "Net worth range not provided.",
              "$0 - $4,999": "$0 to $4,999.",
              "$5,000 - $24,999": "$5,000 to $24,999.",
              "$25,000 - $49,999": "$25,000 to $49,999.",
              "$50,000 - $99,999": "$50,000 to $99,999.",
              "$100,000 - $199,999": "$100,000 to $199,999.",
              "$200,000 - $499,999": "$200,000 to $499,999.",
              "$500,000 - $999,999": "$500,000 to $999,999.",
              "$1,000,000 - $4,999,999": "$1,000,000 to $4,999,999.",
              "$5,000,000 - $9,999,999": "$5,000,000 to $9,999,999.",
              "$10,000,000+": "$10,000,000 or more."
            },
            "x-sensitive": true
          },
          "networthTotalRange": {
            "type": "string",
            "example": "$0 - $24,999",
            "description": "![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==)\nThe User's net total net worth range.",
            "enum": [
              "Unknown",
              "$0 - $4,999",
              "$5,000 - $24,999",
              "$25,000 - $49,999",
              "$50,000 - $99,999",
              "$100,000 - $199,999",
              "$200,000 - $499,999",
              "$500,000 - $999,999",
              "$1,000,000 - $4,999,999",
              "$5,000,000 - $9,999,999",
              "$10,000,000+"
            ],
            "x-enumDescriptions": {
              "Unknown": "Net worth range not provided.",
              "$0 - $4,999": "$0 to $4,999.",
              "$5,000 - $24,999": "$5,000 to $24,999.",
              "$25,000 - $49,999": "$25,000 to $49,999.",
              "$50,000 - $99,999": "$50,000 to $99,999.",
              "$100,000 - $199,999": "$100,000 to $199,999.",
              "$200,000 - $499,999": "$200,000 to $499,999.",
              "$500,000 - $999,999": "$500,000 to $999,999.",
              "$1,000,000 - $4,999,999": "$1,000,000 to $4,999,999.",
              "$5,000,000 - $9,999,999": "$5,000,000 to $9,999,999.",
              "$10,000,000+": "$10,000,000 or more."
            },
            "x-sensitive": true
          },
          "investmentEquitiesExperience": {
            "type": "string",
            "example": "LIMITED",
            "description": "Trading experience level.",
            "enum": [
              "LIMITED",
              "NONE",
              "GOOD",
              "EXCELLENT"
            ],
            "x-enumDescriptions": {
              "LIMITED": "Limited trading knowledge or experience.",
              "NONE": "No trading knowledge or experience.",
              "GOOD": "Good trading knowledge and experience.",
              "EXCELLENT": "Excellent trading knowledge and extensive experience."
            }
          },
          "investmentEquitiesYears": {
            "type": "string",
            "example": "YRS_10_PLUS",
            "description": "Number of years equity trading experience.",
            "enum": [
              "YRS_1_LESS",
              "YRS_1_2",
              "YRS_3_5",
              "YRS_6_9",
              "YRS_10_PLUS"
            ],
            "x-enumDescriptions": {
              "YRS_1_LESS": "Less than 1 year.",
              "YRS_1_2": "1 to 2 years.",
              "YRS_3_5": "3 to 5 years.",
              "YRS_6_9": "6 to 9 years.",
              "YRS_10_PLUS": "10 or more years."
            }
          },
          "investmentEquitiesTradesPerYear": {
            "type": "string",
            "example": "YRS_10_14",
            "description": "Total number of trades per year.",
            "enum": [
              "YRS_0_9",
              "YRS_10_14",
              "YRS_15_24",
              "YRS_25_74",
              "YRS_75_PLUS"
            ],
            "x-enumDescriptions": {
              "YRS_0_9": "0 to 9 trades per year.",
              "YRS_10_14": "10 to 14 trades per year.",
              "YRS_15_24": "15 to 24 trades per year.",
              "YRS_25_74": "25 to 74 trades per year.",
              "YRS_75_PLUS": "75 or more trades per year."
            }
          },
          "investmentEquitiesAverageTradeSize": {
            "type": "string",
            "example": "AVG_0_9999",
            "description": "Average per trade size",
            "enum": [
              "AVG_0_9999",
              "AVG_10000_24999",
              "AVG_25000_PLUS"
            ],
            "x-enumDescriptions": {
              "AVG_0_9999": "$0 to $9,999.",
              "AVG_10000_24999": "$10,000 to $24,999.",
              "AVG_25000_PLUS": "$25,000 or more."
            }
          },
          "investmentOptionsExperience": {
            "type": "string",
            "example": "LIMITED",
            "description": "Trading experience level.",
            "enum": [
              "LIMITED",
              "NONE",
              "GOOD",
              "EXCELLENT"
            ],
            "x-enumDescriptions": {
              "LIMITED": "Limited trading knowledge or experience.",
              "NONE": "No trading knowledge or experience.",
              "GOOD": "Good trading knowledge and experience.",
              "EXCELLENT": "Excellent trading knowledge and extensive experience."
            }
          },
          "investmentOptionsYears": {
            "type": "string",
            "example": "YRS_10_PLUS",
            "description": "Number of years equity trading experience.",
            "enum": [
              "YRS_1_LESS",
              "YRS_1_2",
              "YRS_3_5",
              "YRS_6_9",
              "YRS_10_PLUS"
            ],
            "x-enumDescriptions": {
              "YRS_1_LESS": "Less than 1 year.",
              "YRS_1_2": "1 to 2 years.",
              "YRS_3_5": "3 to 5 years.",
              "YRS_6_9": "6 to 9 years.",
              "YRS_10_PLUS": "10 or more years."
            }
          },
          "investmentOptionsTradesPerYear": {
            "type": "string",
            "example": "YRS_10_14",
            "description": "Total number of trades per year.",
            "enum": [
              "YRS_0_9",
              "YRS_10_14",
              "YRS_15_24",
              "YRS_25_74",
              "YRS_75_PLUS"
            ],
            "x-enumDescriptions": {
              "YRS_0_9": "0 to 9 trades per year.",
              "YRS_10_14": "10 to 14 trades per year.",
              "YRS_15_24": "15 to 24 trades per year.",
              "YRS_25_74": "25 to 74 trades per year.",
              "YRS_75_PLUS": "75 or more trades per year."
            }
          },
          "investmentOptionsAverageTradeSize": {
            "type": "string",
            "example": "AVG_0_9999",
            "description": "A unique identifier for the Deposit.",
            "enum": [
              "AVG_0_9999",
              "AVG_10000_24999",
              "AVG_25000_PLUS"
            ],
            "x-enumDescriptions": {
              "AVG_0_9999": "$0 to $9,999.",
              "AVG_10000_24999": "$10,000 to $24,999.",
              "AVG_25000_PLUS": "$25,000 or more."
            }
          },
          "investmentEquitiesKnowledge": {
            "type": "string",
            "example": "LIMITED",
            "description": "Self assessed knowledge level of equity trading.",
            "enum": [
              "LIMITED",
              "NONE",
              "GOOD",
              "EXCELLENT"
            ],
            "x-enumDescriptions": {
              "LIMITED": "Limited trading knowledge or experience.",
              "NONE": "No trading knowledge or experience.",
              "GOOD": "Good trading knowledge and experience.",
              "EXCELLENT": "Excellent trading knowledge and extensive experience."
            }
          },
          "investmentOptionsKnowledge": {
            "type": "string",
            "example": "LIMITED",
            "description": "Self assessed knowledge level of options trading.",
            "enum": [
              "LIMITED",
              "NONE",
              "GOOD",
              "EXCELLENT"
            ],
            "x-enumDescriptions": {
              "LIMITED": "Limited trading knowledge or experience.",
              "NONE": "No trading knowledge or experience.",
              "GOOD": "Good trading knowledge and experience.",
              "EXCELLENT": "Excellent trading knowledge and extensive experience."
            }
          },
          "investmentEquitiesYearsOfExperience": {
            "type": "number",
            "example": 3,
            "description": "Number of years of experience trading equities."
          },
          "investmentEquitiesTradesPerYearV2": {
            "type": "number",
            "example": 15,
            "description": "Number of equity trades per year."
          },
          "investmentEquitiesAverageTransactionAmount": {
            "type": "number",
            "example": 5000,
            "description": "Average transaction amount of equity trades."
          },
          "investmentEquitiesTransactionTypes": {
            "type": "array",
            "description": "Types of equity transactions the user has experience with.",
            "items": {
              "type": "string",
              "example": "LONG",
              "enum": [
                "LONG",
                "SHORT",
                "MARGIN"
              ],
              "x-enumDescriptions": {
                "LONG": "Long equity positions.",
                "SHORT": "Short equity positions.",
                "MARGIN": "Margin trading positions."
              }
            }
          },
          "investmentOptionsYearsOfExperience": {
            "type": "number",
            "example": 2,
            "description": "Number of years of experience trading options."
          },
          "investmentOptionsTradesPerYearV2": {
            "type": "number",
            "example": 10,
            "description": "Number of options trades per year."
          },
          "investmentOptionsAverageTransactionAmount": {
            "type": "number",
            "example": 3000,
            "description": "Average transaction amount of options trades."
          },
          "investmentOptionsTransactionTypes": {
            "type": "array",
            "description": "Types of options transactions the user has experience with.",
            "items": {
              "type": "string",
              "example": "LONG",
              "enum": [
                "COVERED",
                "LONG",
                "SPREADS",
                "NAKED_PUTS",
                "NAKED_CALLS"
              ],
              "x-enumDescriptions": {
                "COVERED": "Covered options strategies, such as covered calls.",
                "LONG": "Long options strategies, such as buying calls or puts.",
                "SPREADS": "Spread options strategies, such as vertical or calendar spreads.",
                "NAKED_PUTS": "Naked (uncovered) put writing.",
                "NAKED_CALLS": "Naked (uncovered) call writing."
              }
            }
          },
          "investmentFixedIncomeDeclinedToAnswer": {
            "type": "boolean",
            "example": false,
            "description": "True, if the user declined to answer questions regarding fixed income trading."
          },
          "investmentCommodityDeclinedToAnswer": {
            "type": "boolean",
            "example": false,
            "description": "True, if the user declined to answer questions regarding commodity trading."
          },
          "investmentOtherFinancialDeclinedToAnswer": {
            "type": "boolean",
            "example": false,
            "description": "True, if the user declined to answer questions regarding other financial trading."
          },
          "secondaryInvestmentObjectives": {
            "type": "array",
            "description": "The User's secondary investment objectives. **Deprecated values:** LONG_TERM, INFREQUENT, FREQUENT, ACTIVE_DAILY.",
            "items": {
              "type": "string",
              "example": "INCOME",
              "enum": [
                "LONG_TERM",
                "INFREQUENT",
                "FREQUENT",
                "ACTIVE_DAILY",
                "NEW",
                "CAPITAL_PRESERVATION",
                "GROWTH",
                "INCOME",
                "SPECULATION"
              ],
              "x-enumDescriptions": {
                "LONG_TERM": "Long-term buy and hold strategy. Deprecated — replaced by CAPITAL_PRESERVATION and/or GROWTH.",
                "INFREQUENT": "Infrequent trading activity. Deprecated — replaced by CAPITAL_PRESERVATION and/or INCOME.",
                "FREQUENT": "Frequent trading activity. Deprecated — replaced by GROWTH and/or INCOME.",
                "ACTIVE_DAILY": "Active daily trading. Deprecated — replaced by GROWTH and/or SPECULATION.",
                "NEW": "New to trading with no prior experience.",
                "CAPITAL_PRESERVATION": "Capital preservation.",
                "GROWTH": "Growth.",
                "INCOME": "Income.",
                "SPECULATION": "Speculation."
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}
```

# Sibling pages

* [Create User](https://developer.drivewealth.com/apis/reference/post_users.md)
* [Update User](https://developer.drivewealth.com/apis/reference/patch_users-userid.md)
* [Retrieve KYC](https://developer.drivewealth.com/apis/reference/get_users-userid-kyc-status.md)