Embedded

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/argyle9a25/json-schema/argyle9a25-client-session-schema.json",
  "title": "Embedded",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/argyle9a25-sessions-api-openapi.yml#/components/schemas/ClientSession",
  "type": "object",
  "properties": {
    "verification": {
      "type": "string",
      "format": "uuid",
      "description": "Verification ID associated with the session."
    },
    "configuration": {
      "$ref": "#/$defs/ClientSessionConfiguration"
    },
    "link": {
      "type": "string",
      "description": "URL used to launch the payroll or banking frontend experience. For payroll, use it as `connectUrl` when initializing the [Web SDK](/link/initialization/web#initialize-with-connecturl); the returned session URL already determines whether the session runs in Sandbox or Production. Alternatively, open it directly for [Hosted Link](/link/initialization/hosted-link). For banking, pass this value to the [banking SDK](/verifications/verification-types/banking#launch-the-banking-session) as `connectURL`. Hosted or no-SDK banking flows must be enabled by Argyle before use. Session links expire after one hour. A new session link can be created at any time by creating another session for the active verification."
    },
    "data_source": {
      "type": "string",
      "enum": [
        "payroll",
        "banking"
      ],
      "description": "Source of connection data."
    }
  },
  "$defs": {
    "ClientSessionConfiguration": {
      "allOf": [
        {
          "$ref": "#/$defs/ClientSessionCreateConfiguration"
        }
      ]
    },
    "ClientSessionCreateConfiguration": {
      "type": "object",
      "description": "Connection session configuration for payroll and banking verifications.",
      "properties": {
        "experience": {
          "type": "string",
          "format": "uuid",
          "description": "Banking only. Optional bank connection experience customization ID."
        },
        "single_use_url": {
          "type": "boolean",
          "description": "Banking only. If `true`, the session link expires after one successful connection."
        },
        "redirect_url": {
          "type": [
            "string",
            "null"
          ],
          "description": "Payroll and banking. Optional redirect URL after session completion. Hosted/direct-launch flows should always set this. On desktop browsers, use a regular `https://` URL. For mobile app flows, use a custom scheme such as `your-custom-scheme://return-to-app`, or a Universal Link on iOS / App Link on Android. Universal Links and App Links are the more modern approach. You can include an application-owned state or nonce value to match the returning browser session to an internal user, session, or verification. Argyle appends `user_submission_complete` and `user_attempted_employer_selection`, which mirror the [`onClose`](/link/reference/callbacks#onclose) fields."
        },
        "flow_id": {
          "type": "string",
          "description": "Payroll only. Optional payroll embedded connection experience customization ID."
        },
        "items": {
          "type": "array",
          "description": "Payroll only. Limits Link to the provided Items. If one Item is provided, Link skips search and opens that Item's login screen. If multiple Items are provided, Link shows only those Items.",
          "items": {
            "type": "string"
          }
        },
        "language": {
          "type": "string",
          "enum": [
            "EN",
            "ES",
            "RU",
            "ZH"
          ],
          "description": "Payroll only. Supported Link [display language](/link/initialization/overview#optional-initialization-parameters)."
        },
        "mobile_app": {
          "type": "boolean",
          "description": "Payroll only. Set to `true` when the session is used in a mobile app, including Hosted Link opened in a secure browser context."
        }
      }
    }
  }
}