Argyle · Schema

ClientVerification

Employment DataPayrollIncome VerificationGig EconomyFinancial DataEmployment HistoryEarned Wage AccessDirect Deposit

Properties

Name Type Description
id string Unique ID of the verification.
user string ID of the user associated with the verification.
created_at string Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the verification was requested.
updated_at string Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the verification object was last updated.
channel string Origin of the verification order.
status object
report object
employments array List of employments for the user. Documents only.
loan object
billing object
data_source string Source of verification data.
View JSON Schema on GitHub

JSON Schema

clientverification.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argyle/refs/heads/main/json-schema/clientverification.json",
  "title": "ClientVerification",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Unique ID of the verification."
    },
    "user": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the user associated with the verification."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the verification was requested."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)) when the verification object was last updated."
    },
    "channel": {
      "type": "string",
      "enum": [
        "api",
        "encompass"
      ],
      "example": "api",
      "description": "Origin of the verification order."
    },
    "status": {
      "$ref": "#/components/schemas/ClientVerificationStatus"
    },
    "report": {
      "$ref": "#/components/schemas/ClientVerificationReport"
    },
    "employments": {
      "type": "array",
      "description": "List of employments for the user. Documents only.",
      "items": {
        "$ref": "#/components/schemas/ClientVerificationEmployment"
      }
    },
    "loan": {
      "$ref": "#/components/schemas/ClientVerificationLoan"
    },
    "billing": {
      "$ref": "#/components/schemas/ClientVerificationBilling"
    },
    "data_source": {
      "type": "string",
      "enum": [
        "payroll",
        "banking",
        "documents"
      ],
      "description": "Source of verification data."
    }
  }
}