Skip to main content
POST
JavaScript
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
customer_id
string
required

Unique identifier for the customer

Required string length: 1 - 255
customer_name
string
required

Name of the customer

Required string length: 1 - 255
products
enum<string>[]
required

The Finch products to request access to. Use benefits to access deductions endpoints — deduction is a deprecated alias that is still accepted but should not be combined with benefits.

Available options:
benefits,
company,
deduction,
directory,
documents,
employment,
individual,
payment,
pay_statement,
plans,
plans_dependents,
plans_enrollments,
recordkeeping,
ssn
customer_email
string<email> | null

Email address of the customer

redirect_uri
string | null

The URI to redirect to after the Connect flow is completed. Required if you use the redirect flow, and it must be registered on the Credentials tab of the Finch Developer Dashboard. Omit it for the embedded flow (Connect SDK).

minutes_to_expire
number | null

The number of minutes until the session expires (defaults to 129,600, which is 90 days)

Required range: 1 <= x <= 129600
sandbox
enum<string> | null

Sandbox mode for testing

Available options:
finch,
provider,
null
manual
boolean | null

Enable manual authentication mode

integration
object | null

Integration configuration for the connect session

recordkeeping
object | null

Optional recordkeeping configuration. Can only be provided when the recordkeeping product is requested. Currently supports recordkeeper set to voya, empower, fidelity, or transamerica.

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 authentication