Skip to main content
POST
/
v2
/
sessions
curl --request POST \
  --url https://api-sandbox.argyle.com/v2/sessions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
  "configuration": {
    "redirect_url": null,
    "flow_id": "12ABCD3E",
    "language": "EN",
    "mobile_app": true
  }
}
'
{
  "verification": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
  "configuration": {
    "experience": null,
    "single_use_url": false,
    "redirect_url": null,
    "flow_id": "12ABCD3E",
    "language": "EN",
    "mobile_app": true
  },
  "link": "https://connect.argyle.com/?...",
  "data_source": "payroll"
}

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
​
verification
string<uuid>
required

ID of the verification used to initialize the session.

​
configuration
object

Connection session configuration for payroll and banking verifications.

Response

200 - application/json

Client connection session object.

​
verification
string<uuid>

Verification ID associated with the session.

​
configuration
object

Connection session configuration for payroll and banking verifications.

​
link
string

URL used to launch the payroll or banking connection experience.

​
data_source
enum<string>

Source of connection data.

Available options:
payroll,
banking