Skip to main content
POST
JavaScript
NOTE: The connect session uses Basic Auth; in the sample request above use client_id as the username and client_secret as a password. For example: Authorization: Basic <base64 encoded client_id:client_secret>

Authorizations

Authorization
string
header
required

Please use base64 encoded client_id:client_secret

Body

application/json
connection_id
string
required

The ID of the existing connection to reauthenticate

redirect_uri
string<uri> | null

The URI to redirect to after the Connect flow is completed

minutes_to_expire
integer

The number of minutes until the session expires (defaults to 43,200, which is 30 days)

products
enum<string>[] | null

The products to request access to (optional for reauthentication). Use benefits to access deductions endpoints — deduction is a deprecated alias that is still accepted but should not be combined with benefits.

Available options:
benefits,
company,
deduction,
directory,
documents,
employment,
individual,
payment,
pay_statement,
recordkeeping,
ssn

Response

Created

session_id
string
required

The unique identifier for the created connect session

connect_url
string<uri>
required

The Connect URL to redirect the user to for reauthentication