Sign in

v1

latestOpenAPI 3.0.02026-07-2641723.8 KB

Create a session

Create a connection session and return a link URL that launches the frontend experience.

Session links expire after one hour. A new session link can be created at any time by creating another session for the active verification.

<Note>This endpoint is for payroll and banking verifications only.</Note>

post/v2/sessions

Request body

verificationstring uuid required

ID of the verification used to initialize the session.

Example request

{
  "configuration": {
    "items": [
      "item_000000001",
      "item_000000002"
    ]
  }
}

Response

verificationstring uuid

Verification ID associated with the session.

linkstring

URL used to launch the payroll or banking frontend experience. For payroll, use it as connectUrl when initializing the Web SDK; the returned session URL already determines whether the session runs in Sandbox or Production. Alternatively, open it directly for Hosted Link. For banking, pass this value to the banking SDK 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'payroll' | 'banking'

Source of connection data.

Example response

{
  "configuration": {
    "items": [
      "item_000000001",
      "item_000000002"
    ]
  }
}