POST
/
connect
/
sessions

Authorizations

Authorization
string
headerrequired

Please use base64 encoded client_id:client_secret

Headers

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

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

Body

application/json
customer_id
string
required
customer_name
string
required
customer_email
string | null
products
enum<string>[]
required
Available options:
company,
directory,
individual,
employment,
payment,
pay_statement,
benefits,
ssn
redirect_uri
string | null
minutes_to_expire
number | null

The number of minutes until the session expires (defaults to 20,160, which is 14 days)

sandbox
enum<string> | null
Available options:
finch,
provider
manual
boolean | null
integration
object | null

Response

201 - application/json
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