Argyle · Schema

ClientVerificationCreateRequest

Request body for ordering a verification. - `user` and `report` are required for all requests. - `employments` is required for document verifications only. - `report.configuration` is used for banking verifications only.

Employment DataPayrollIncome VerificationGig EconomyFinancial DataEmployment HistoryEarned Wage AccessDirect Deposit

Properties

Name	Type	Description
user	string	User ID for the verification.
employments	array	List of employments for the user. Required for document verifications only. Not used for payroll or banking verifications.
report	object
loan	object
billing	object

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/clientverificationcreaterequest.json",
  "title": "ClientVerificationCreateRequest",
  "type": "object",
  "description": "Request body for ordering a verification.\n\n- `user` and `report` are required for all requests.\n- `employments` is required for document verifications only.\n- `report.configuration` is used for banking verifications only.",
  "properties": {
    "user": {
      "type": "string",
      "format": "uuid",
      "description": "User ID for the verification."
    },
    "employments": {
      "type": "array",
      "description": "List of employments for the user.\n\nRequired for document verifications only. Not used for payroll or banking verifications.",
      "items": {
        "$ref": "#/components/schemas/ClientVerificationEmploymentRequest"
      }
    },
    "report": {
      "$ref": "#/components/schemas/ClientVerificationCreateReportRequest"
    },
    "loan": {
      "$ref": "#/components/schemas/ClientVerificationLoan"
    },
    "billing": {
      "$ref": "#/components/schemas/ClientVerificationBilling"
    }
  },
  "required": [
    "user",
    "report"
  ]
}