Argyle · Schema

ClientUser

Client user object.

Employment DataPayrollIncome VerificationGig EconomyFinancial DataEmployment HistoryEarned Wage AccessDirect Deposit

Properties

Name	Type	Description
id	string	Unique ID of the user.
created_at	string	Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the user was created.
items_connected	array	Items the user has connected through Link.
employers_connected	array	Employers associated with the connected items.
first_name	string	User first name.
last_name	string	User last name.
email	string	User email address.
phone_number	string	User phone number.
ssn	string	User Social Security number.
address	object
birth_date	object
external_metadata	object	Additional metadata for internal workflows.
external_id	string	External identifier for your internal mapping.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argyle/refs/heads/main/json-schema/clientuser.json",
  "title": "ClientUser",
  "type": "object",
  "description": "Client user object.",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the user."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the user was created."
    },
    "items_connected": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Items the user has connected through Link."
    },
    "employers_connected": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Employers associated with the connected items."
    },
    "first_name": {
      "type": "string",
      "description": "User first name."
    },
    "last_name": {
      "type": "string",
      "description": "User last name."
    },
    "email": {
      "type": "string",
      "description": "User email address."
    },
    "phone_number": {
      "type": "string",
      "description": "User phone number."
    },
    "ssn": {
      "type": "string",
      "description": "User Social Security number."
    },
    "address": {
      "$ref": "#/components/schemas/ClientAddress"
    },
    "birth_date": {
      "$ref": "#/components/schemas/ClientBirthDate"
    },
    "external_metadata": {
      "type": "object",
      "description": "Additional metadata for internal workflows.",
      "additionalProperties": true
    },
    "external_id": {
      "type": "string",
      "nullable": true,
      "description": "External identifier for your internal mapping."
    }
  }
}