POST
/
connect
/
sessions
/
reauthenticate
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

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

  console.log(response.session_id);
}

main();
{
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "connect_url": "https://connect.tryfinch.com/authorize?session=550e8400-e29b-41d4-a716-446655440000"
}

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 | null

The URI to redirect to after the Connect flow is completed

​
minutes_to_expire
integer | null

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)

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

Response

201
application/json
Created
​
session_id
string
required

The unique identifier for the created connect session

​
connect_url
string
required

The Connect URL to redirect the user to for reauthentication

Was this page helpful?

Create a new connect sessionCreate Access Token