Argyle · Schema

PartnerUserCreateRequest

Employment DataPayrollIncome VerificationGig EconomyFinancial DataEmployment HistoryEarned Wage AccessDirect Deposit

Properties

Name	Type	Description
client	string	ID of the client on whose behalf the user is created. Provided to you by your Argyle Customer Success manager.
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 partner 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/partnerusercreaterequest.json",
  "title": "PartnerUserCreateRequest",
  "type": "object",
  "properties": {
    "client": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the client on whose behalf the user is created.\n\n<Info>\nProvided to you by your Argyle Customer Success manager.\n</Info>\n"
    },
    "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/PartnerAddress"
    },
    "birth_date": {
      "$ref": "#/components/schemas/PartnerBirthDate"
    },
    "external_metadata": {
      "type": "object",
      "description": "Additional metadata for internal partner workflows.",
      "additionalProperties": true,
      "properties": {
        "suppress_verification": {
          "type": "boolean",
          "description": "Set to `true` for banking and document verification workflows."
        }
      }
    },
    "open_banking": {
      "$ref": "#/components/schemas/PartnerOpenBanking"
    },
    "external_id": {
      "type": "string",
      "nullable": true,
      "description": "External identifier for your internal mapping."
    }
  },
  "required": [
    "client"
  ]
}