POST
/
connect
/
sessions
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.new({
  customer_id: 'x',
  customer_name: 'x',
  products: ['company'],
});

console.log(response.session_id);
{
  "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<date>
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

Response

201
application/json

Created

The response is of type object.