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

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

async function main() {
  const response = await client.connect.sessions.new({
    customer_id: 'x',
    customer_name: 'x',
    products: ['company'],
  });

  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

Headers

​
Finch-API-Version
string
default:
2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Body

application/json
​
customer_id
string
required
Required string length: 1 - 255
​
customer_name
string
required
Required string length: 1 - 255
​
products
enum<string>[]
required

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

Available options:
company,
directory,
individual,
employment,
payment,
pay_statement,
benefits,
ssn
​
customer_email
string | null
​
redirect_uri
string | null
​
minutes_to_expire
number | null

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

Required range: 1 < x < 43200
​
sandbox
enum<string> | null
Available options:
finch,
provider
​
manual
boolean | null
​
integration
object | null

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 authentication

Was this page helpful?

Get DocumentCreate a new Connect session for reauthentication