User

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/argyle9a25/json-schema/argyle9a25-user-schema.json",
  "title": "User",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/argyle9a25-users-api-openapi.yml#/components/schemas/User",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the user."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp (ISO 8601) when the user object was created."
    },
    "items_connected": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Items the user has connected through Link. Typically employers or payroll platforms."
    },
    "employers_connected": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Individual employers associated with the connected Items."
    },
    "external_metadata": {
      "type": "object",
      "description": "Free-text field where additional context for the user can be added.\n- Can be any valid JSON, such as a string or object.\n\n**Note:** Using `external_id` (see below) is recommended when the ability to filter users by an external value is needed.\n",
      "properties": {
        "broker": {
          "$ref": "#/$defs/Broker"
        }
      }
    },
    "external_id": {
      "type": "string",
      "description": "Free-text field where [additional context](/overview/data-structure/users#external-identifiers) for the user can be added.\n- Can be any string of 100 characters or less.\n- Multiple users can have the same `external_id`.\n\nOften used to group users, or associate your internal ID's to users.\n- Can be attached to [invites](/console/flows/email-sms-templates#inviting-new-users) or [shareable URLs](/console/flows/shareable-urls#customizations).\n- Can be used as a query parameter when [listing users](/api-reference/users#list). (Only exact matches are supported)\n- Can be used to search for specific users within the [Connections](https://console.argyle.com/connections) section of Console.\n- Will appear on billing CSVs if associated with a user.\n"
    },
    "first_name": {
      "type": "string",
      "description": "First name of the user."
    },
    "last_name": {
      "type": "string",
      "description": "Last name of the user."
    },
    "email": {
      "type": "string",
      "description": "Email of the user."
    },
    "phone_number": {
      "type": "string",
      "description": "Phone number of the user. E.164 international format."
    },
    "ssn": {
      "type": "string",
      "description": "Social Security number of the user."
    },
    "address": {
      "type": "object",
      "description": "Address of the user.",
      "properties": {
        "city": {
          "type": "string",
          "description": "Name of the city, town, district, or similar regional entity."
        },
        "line1": {
          "type": "string",
          "description": "Address-Line 1, usually street address or P.O. Box information."
        },
        "line2": {
          "type": "string",
          "description": "Address-Line 2, usually the apartment or unit number."
        },
        "state": {
          "type": "string",
          "description": "State, county, province, region, or equivalent."
        },
        "country": {
          "type": "string",
          "description": "Two-letter country code (ISO 3166-1 alpha-2 format)."
        },
        "postal_code": {
          "type": "string",
          "description": "Zip code, or equivalent."
        }
      }
    },
    "birth_date": {
      "type": "object",
      "description": "Date of birth of the user.",
      "properties": {
        "year": {
          "type": "integer",
          "description": "Birth year (1900 or later)."
        },
        "month": {
          "type": "integer",
          "description": "Birth month (between 1 and 12)."
        },
        "day": {
          "type": "integer",
          "description": "Birth day (between 1 and 31)."
        }
      }
    }
  },
  "$defs": {
    "Broker": {
      "type": "object",
      "description": "**Note:** Only for wholesale mortgage integrations.\n\nContains information about the user's mortgage broker for [broker-branded invites](/verifications/wholesale-mortgage).\n",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the mortgage broker."
        },
        "phone_number": {
          "type": "string",
          "description": "Phone number of the mortgage broker. [E.164](https://en.wikipedia.org/wiki/E.164) international format."
        },
        "email": {
          "type": "string",
          "description": "Email address of the mortgage broker."
        },
        "nmls": {
          "type": "string",
          "description": "NMLS ID of the mortgage broker."
        }
      }
    }
  }
}