Skip to main content
POST
/
connect
/
sessions
/
reauthenticate
JavaScript
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  clientID: '4ab15e51-11ad-49f4-acae-f343b7794375',
  clientSecret: 'My Client Secret',
});

const response = await client.connect.sessions.reauthenticate({ connection_id: 'connection_id' });

console.log(response.session_id);
{
  "session_id": "<string>",
  "connect_url": "<string>"
}
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)

The Finch products that can be requested during the Connect flow.

Available options:
benefits,
company,
deduction,
directory,
documents,
employment,
individual,
payment,
pay_statement,
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