Argyle · Schema

ClientUserCreateRequest

Request body for creating a client user. This matches the public `/v2/users` request shape. `external_metadata.suppress_verification = true` is recommended when manually orchestrating banking and document verification flows.

Employment DataPayrollIncome VerificationGig EconomyFinancial DataEmployment HistoryEarned Wage AccessDirect Deposit

Properties

Name	Type	Description
first_name	string	User first name.
last_name	string	User last name.
email	string	User email address.
phone_number	string	User phone number. E.164 international format recommended.
ssn	string	User Social Security number.
address	object
birth_date	object
external_metadata	object	Additional metadata for internal workflows.
open_banking	object
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/clientusercreaterequest.json",
  "title": "ClientUserCreateRequest",
  "type": "object",
  "description": "Request body for creating a client user.\n\nThis matches the public `/v2/users` request shape.\n\n`external_metadata.suppress_verification = true` is recommended when manually orchestrating banking and document verification flows.\n",
  "properties": {
    "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. E.164 international format recommended."
    },
    "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
    },
    "open_banking": {
      "$ref": "#/components/schemas/ClientOpenBanking"
    },
    "external_id": {
      "type": "string",
      "nullable": true,
      "description": "External identifier for your internal mapping."
    }
  }
}