v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB

Connect

Create a new connect session

Create a new connect session for an employer

post/connect/sessions

Headers

Finch-API-Versionstring date required

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

Request body

customer_idstring required

Unique identifier for the customer

customer_namestring required

Name of the customer

customer_emailstring email nullable

Email address of the customer

productsConnectProducts[] 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.

redirect_uristring nullable

The URI to redirect to after the Connect flow is completed

minutes_to_expirenumber nullable

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

sandbox'finch' | 'provider' | 'null' nullable

Sandbox mode for testing

manualboolean nullable

Enable manual authentication mode

Response

Created

session_idstring required

The unique identifier for the created connect session

connect_urlstring uri required

The Connect URL to redirect the user to for authentication