import Finch from '@tryfinch/finch-api';const client = new Finch({ clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted});const response = await client.connect.sessions.new({ customer_id: 'x', customer_name: 'x', products: ['benefits'],});console.log(response.session_id);
import os
from finch import Finch
client = Finch(
client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted
client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted
)
response = client.connect.sessions.new(
customer_id="x",
customer_name="x",
products=["benefits"],
)
print(response.session_id)
import Finch from '@tryfinch/finch-api';const client = new Finch({ clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted});const response = await client.connect.sessions.new({ customer_id: 'x', customer_name: 'x', products: ['benefits'],});console.log(response.session_id);
import os
from finch import Finch
client = Finch(
client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted
client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted
)
response = client.connect.sessions.new(
customer_id="x",
customer_name="x",
products=["benefits"],
)
print(response.session_id)
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>
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.
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).
Optional recordkeeping configuration. Can only be provided when the recordkeeping product is requested. Currently supports recordkeeper set to voya, empower, fidelity, or transamerica.
The Connect URL to redirect the user to for authentication
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Finch","colors":{"primary":"#161616","light":"#FAFAFA","dark":"#3E4AE7"},"logo":{"light":"https://mintcdn.com/finch/ejF2Kw2CeeMQKCJw/logo/logo-black.svg?fit=max\u0026auto=format\u0026n=ejF2Kw2CeeMQKCJw\u0026q=85\u0026s=e490dba98fb7b16e8f9f5ab4a9a58a5c","dark":"https://mintcdn.com/finch/ejF2Kw2CeeMQKCJw/logo/logo-white.svg?fit=max\u0026auto=format\u0026n=ejF2Kw2CeeMQKCJw\u0026q=85\u0026s=9132a1fde9ad8880fbf81ac32e53e6b2"},"favicon":"https://mintcdn.com/finch/8U6M212KK5wde_yD/favicon.png?fit=max\u0026auto=format\u0026n=8U6M212KK5wde_yD\u0026q=85\u0026s=c54c63bf4768a5eb32ea7e306f52ed1e","navbar":{"links":[{"href":"https://dashboard.tryfinch.com/signup","label":"Sign Up"}],"primary":{"type":"button","label":"Sign In","href":"https://login.tryfinch.com/u/login?state=hKFo2SBmakdGQlE4STYwYzhmRkYzc0ZOTVV3c1VkX2F4UGhuTKFur3VuaXZlcnNhbC1sb2dpbqN0aWTZIENuZ0NHU283dXV5YzlzczQtZFZxUmJQRElJUmt6UGpmo2NpZNkgTlZsT1hZN3N2R25xSlNHYkFSdE1Ga2tnMGJqMkJmbEk"}},"footer":{"socials":{"twitter":"https://twitter.com/tryfinch?lang=en","linkedin":"https://www.linkedin.com/company/finchapi","website":"https://tryfinch.com/"}},"integrations":{"amplitude":{"apiKey":"684ff58ac8711b102376cfd6ded7f199"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":{"style":"sharp-solid","name":"megaphone"},"color":{"light":"#3E4AE7","dark":"#3E4AE7"},"href":"https://developer.tryfinch.com/changelog"},{"anchor":"API Status","icon":{"style":"sharp-solid","name":"signal-bars"},"color":{"light":"#3E4AE7","dark":"#3E4AE7"},"href":"https://status.tryfinch.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"finch","hasAudioNarration":false,"actualSubdomain":"finch","customDomains":["developer.tryfinch.com"],"gitSource":{"type":"github","owner":"finch-api","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aea501821f5e1fb9e87c3b5","collectionId":"fa4f2c75-e058-4e38-bab8-25ee92e85af1","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea501821f5e1fb9e87c3b5"},"feedback":{"thumbs":true,"issues":false,"edits":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aea501821f5e1fb9e87c3b5","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":61},{"language":"default","tag":"Documentation","count":55},{"language":"default","tag":"Implementation Guide","count":23},{"language":"default","tag":"Developer Resources","count":17},{"language":"default","tag":"Sandbox","count":11},{"language":"default","tag":"Management","count":10},{"language":"default","tag":"Payroll","count":10},{"language":"default","tag":"Deductions","count":9},{"language":"default","tag":"Development Guides","count":7},{"language":"default","tag":"Build Backend Application","count":7}]},"assistantConfig":{"deflection":{"enabled":true,"email":"developers@tryfinch.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--finch-purple:#3E4AE7;--finch-purple-dark:#7A84FF}.update-container [class*=bg-primary]{background-color:rgba(62,74,231,.08)!important;color:var(--finch-purple)!important}.dark .update-container [class*=bg-primary]{background-color:rgba(122,132,255,.15)!important;color:var(--finch-purple-dark)!important}#content-side-layout:empty,#table-of-contents-layout:empty{position:absolute}:is(.prose a):not(.dark .prose a):not(:where([aria-label=\"Navigate to header\"])){color:var(--finch-purple);border-bottom:1px solid var(--finch-purple)}:is(.dark .prose a):not(:where([aria-label=\"Navigate to header\"])){color:var(--finch-purple-dark);border-bottom:1px solid var(--finch-purple-dark)}.automated-badge{background-color:#ecfdf3;color:#027a48}.assisted-badge{background-color:#fffaeb;color:#b54708}.dark .automated-badge{background-color:#0c2119!important;color:#12b76a!important}.dark .assisted-badge{background-color:#21140f!important;color:#f79009!important}.pn-container{margin-top:1rem}.pn-search{width:100%;padding:10px 14px;font-size:15px;border:1px solid #d0d5dd;border-radius:8px;outline:0;background:#fff;color:#101828;transition:border-color .15s,box-shadow .15s}.pn-search:focus{border-color:var(--finch-purple);box-shadow:0 0 0 3px rgba(62,74,231,.12)}.pn-search::placeholder{color:#98a2b3}.dark .pn-search{background:#1d2939;border-color:#344054;color:#f2f4f7}.dark .pn-search:focus{border-color:var(--finch-purple-dark);box-shadow:0 0 0 3px rgba(122,132,255,.15)}.pn-filters{display:flex;flex-wrap:wrap;gap:16px;margin:16px 0;align-items:flex-start}.pn-filter-group{display:flex;align-items:center;gap:6px;flex-wrap:wrap}.pn-filter-label,.pn-table thead th{font-weight:600;color:#475467;white-space:nowrap}.pn-filter-label{font-size:13px;margin-right:2px}.dark .pn-filter-label{color:#98a2b3}.pn-checkbox-label,.pn-export-btn,.pn-filter-btn{align-items:center;font-size:13px;font-weight:500;cursor:pointer}.pn-checkbox-label{display:flex;gap:6px;color:#344054}.dark .pn-checkbox-label{color:#d0d5dd}.pn-export-btn,.pn-filter-btn{display:inline-flex;padding:4px 12px;border:1px solid #d0d5dd}.pn-export-btn{gap:6px;border-radius:6px;background:0 0;color:#475467;margin-left:auto}.pn-export-btn:hover{background:#f2f4f7;border-color:#98a2b3}.dark .pn-export-btn{color:#d0d5dd;border-color:#475467}.dark .pn-export-btn:hover{background:#1d2939;border-color:#667085}.pn-filter-btn{border-radius:999px;background:#fff;color:#344054;transition:all .15s;line-height:1.5}.pn-filter-btn:hover{background:#f2f4f7;border-color:#98a2b3}.pn-filter-btn-active{background:var(--finch-purple)!important;color:#fff!important;border-color:var(--finch-purple)!important}.dark .pn-filter-btn{background:#1d2939;border-color:#344054;color:#d0d5dd}.dark .pn-filter-btn:hover{background:#344054;border-color:#475467}.dark .pn-filter-btn-active{background:var(--finch-purple-dark)!important;color:#101828!important;border-color:var(--finch-purple-dark)!important}.pn-results-count{font-size:14px;color:#475467;margin-bottom:12px;font-weight:500}.dark .pn-results-count{color:#98a2b3}.pn-table{width:100%;border-collapse:collapse;font-size:14px;table-layout:auto;margin-left:0!important;margin-right:0!important}#fsm-table-scroll table td,#fsm-table-scroll table th,.pn-table td,.pn-table th{min-width:0!important}.pn-col-narrow{width:1%!important}.pn-td-center,.pn-th-center{text-align:center!important;white-space:nowrap!important;padding-left:6px!important;padding-right:6px!important;width:1%!important;min-width:0!important;max-width:fit-content!important}.pn-th-link,.pn-th-link:link,.pn-th-link:visited,.prose .pn-th-link,.prose a.pn-th-link{color:inherit!important;text-decoration:none!important;border-bottom:none!important;box-shadow:none!important}.pn-th-link:hover,.prose .pn-th-link:hover,.prose a.pn-th-link:hover{text-decoration:underline!important}.pn-table thead th{text-align:left;padding:8px 4px;font-size:12px;text-transform:uppercase;letter-spacing:.04em;border-bottom:2px solid #e4e7ec}.dark .pn-table thead th{color:#98a2b3;border-bottom-color:#344054}.pn-table tbody tr{border-bottom:1px solid #f2f4f7;transition:background .1s}.pn-table tbody tr:hover{background:#f9fafb}.dark .pn-table tbody tr{border-bottom-color:#1d2939}.dark .pn-table tbody tr:hover{background:#1d2939}.pn-table td{padding:8px 4px;vertical-align:middle;overflow:hidden;text-overflow:ellipsis}.pn-table td:first-child,.pn-table th:first-child{padding-left:0!important}.pn-pill{display:inline-block;padding:2px 8px;border-radius:999px;font-size:13px;font-weight:500}.pn-product-pills{display:flex;flex-wrap:wrap;gap:4px}.pn-pill-automated{background:#ecfdf3;color:#027a48}.pn-pill-assisted{background:#fffaeb;color:#b54708}.dark .pn-pill-automated{background:#0c2119;color:#12b76a}.dark .pn-pill-assisted{background:#21140f;color:#f79009}.pn-name-row{display:flex;align-items:center;gap:8px}.pn-name-id{gap:6px}.pn-copy-btn,.pn-id-cell,.pn-name-id{display:inline-flex;align-items:center}.pn-id-cell{gap:4px}.pn-id-cell code{font-size:12px}.pn-copy-btn{justify-content:center;background:0 0;border:0;cursor:pointer;color:#98a2b3;padding:2px;border-radius:4px;transition:color .15s,background .15s}.pn-copy-btn:hover{color:var(--finch-purple);background:#f2f4f7}.dark .pn-copy-btn:hover{color:var(--finch-purple-dark);background:#344054}.assisted-fast-badge,.pn-badge-assisted,.pn-badge-assisted-fast,.pn-badge-automated{display:inline-block;padding:1px 6px;border-radius:999px;font-size:11px;font-weight:500;white-space:nowrap}.assisted-fast-badge,.pn-badge-assisted-fast{background-color:#fffaeb;color:#b54708}.dark .assisted-fast-badge{background-color:#21140f!important;color:#f79009!important}.pn-badge-none{color:#98a2b3;font-size:11px}.pn-badge-request,.prose .pn-badge-request,.prose a.pn-badge-request{font-size:11px;color:#667085!important;text-decoration:none!important;border-bottom:none!important}.pn-badge-request:hover,.prose .pn-badge-request:hover,.prose a.pn-badge-request:hover{text-decoration:underline!important}.dark .pn-badge-request,.dark .prose .pn-badge-request,.dark .prose a.pn-badge-request{color:#667085!important}.pn-status-beta,.pn-status-ga{display:inline-block;padding:1px 6px;border-radius:999px;font-size:10px;font-weight:600;letter-spacing:.03em}.pn-status-ga{background:#eff8ff;color:#175cd3;text-transform:uppercase}.pn-status-beta{background:#f4f3ff;color:#5925dc}.dark .pn-status-ga{background:#0c1f3d;color:#84adff}.dark .pn-status-beta{background:#1d1547;color:#bdb4fe}@media (max-width:768px){.pn-filters{flex-direction:column;gap:10px}.pn-table{font-size:12px}.pn-table td,.pn-table th{padding:8px 6px}}.fsm-auth-api_token,.fsm-auth-assisted,.fsm-auth-credential,.fsm-auth-oauth{font-size:11px;font-weight:500;padding:2px 8px;border-radius:9999px;display:inline-block}.fsm-auth-oauth{background:#f0fdf4;color:#15803d}.fsm-auth-credential{background:#eff6ff;color:#1d4ed8}.fsm-auth-api_token{background:#faf5ff;color:#7e22ce}.fsm-auth-assisted{background:#fefce8;color:#a16207}.dark .fsm-auth-oauth{background:#0a2618;color:#6ee7a0}.dark .fsm-auth-credential{background:#0c1a2e;color:#7db8f5}.dark .fsm-auth-api_token{background:#1a0e2e;color:#c4a5f5}.dark .fsm-auth-assisted{background:#231a0a;color:#e5b85c}.fsm-beta-callout{border-radius:8px;border:1px solid #bfdbfe;background:#eff6ff;padding:12px 16px;margin-bottom:16px;font-size:14px;color:#1e40af;display:flex;align-items:center;gap:10px}.fsm-beta-callout svg,.fsm-method{flex-shrink:0}.dark .fsm-beta-callout{border-color:#1e3a5f;background:#0c1a2e;color:#93c5fd}.dark .fsm-beta-callout circle{stroke:#60a5fa}.dark .fsm-beta-callout text{fill:#60a5fa}.fsm-method{font-size:9px;font-weight:700;line-height:1;padding:2px 5px;border-radius:3px;letter-spacing:.02em}.fsm-method-get{color:#16a34a;background:#f0fdf4}.fsm-method-post{color:#2563eb;background:#eff6ff}.fsm-method-del{color:#dc2626;background:#fef2f2}.dark .fsm-method-get{color:#6ee7a0;background:#0a2618}.dark .fsm-method-post{color:#7db8f5;background:#0c1a2e}.dark .fsm-method-del{color:#f87171;background:#2a0a0a}.fsm-csv-btn,.fsm-drop-item{align-items:center;font-size:13px;cursor:pointer;background:0 0}.fsm-csv-btn{display:inline-flex;gap:6px;padding:7px 12px;border:1px solid #e2e8f0;border-radius:8px;font-weight:500;color:#64748b}.fsm-csv-btn:hover{border-color:#94a3b8;color:#475569}.dark .fsm-csv-btn{border-color:#374151;color:#9ca3af}.dark .fsm-csv-btn:hover{border-color:#4b5563;color:#d1d5db}.fsm-drop-item{display:flex;gap:8px;width:100%;padding:5px 10px;border:0;border-radius:6px;text-align:left;color:#4b5563}.fsm-drop-item:hover{background:#f8fafc}.fsm-drop-item-selected{background:#f0f1ff;color:#3e4ae7}.dark .fsm-drop-item{color:#e5e7eb}.dark .fsm-drop-item:hover{background:rgba(255,255,255,.08)}.dark .fsm-drop-item-selected{background:rgba(122,132,255,.15);color:#7a84ff}.fsm-tooltip-wrap{position:relative;display:inline-flex}.fsm-tooltip{display:none;position:absolute;bottom:calc(100% + 6px);left:50%;transform:translateX(-50%);background:#1e293b;color:#f1f5f9;font-size:12px;line-height:1.4;padding:8px 12px;border-radius:8px;width:220px;white-space:normal;text-align:left;box-shadow:0 4px 12px rgba(0,0,0,.15);z-index:100;pointer-events:none}.fsm-btn-tooltip-wrap:hover .fsm-btn-tooltip,.fsm-tip:hover .fsm-tip-text,.fsm-tooltip-wrap:hover .fsm-tooltip{display:block}.fsm-btn-tooltip-wrap{position:relative;display:inline-flex}.fsm-btn-tooltip{display:none;position:absolute;bottom:calc(100% + 6px);left:50%;transform:translateX(-50%);background:#1e293b;color:#f1f5f9;font-size:11px;padding:4px 8px;border-radius:4px;white-space:nowrap;z-index:100;pointer-events:none}.fsm-tip{color:#9ca3af}.dark .fsm-tip{color:#6b7280}.fsm-tip-text{display:none;position:absolute;bottom:calc(100% + 6px);right:-8px;background:#1e293b;color:#f1f5f9;font-size:11px;line-height:1.4;padding:6px 10px;border-radius:6px;text-align:left;width:max-content;max-width:320px;z-index:9999;pointer-events:none}#fsm-table-scroll,#fsm-top-scroll{margin-left:0!important;margin-right:0!important;max-width:100%!important}#fsm-table-scroll::-webkit-scrollbar,#fsm-top-scroll::-webkit-scrollbar{height:8px}#fsm-table-scroll::-webkit-scrollbar-track,#fsm-top-scroll::-webkit-scrollbar-track{background:0 0}#fsm-table-scroll::-webkit-scrollbar-thumb,#fsm-top-scroll::-webkit-scrollbar-thumb{background:#d1d5db;border-radius:4px}#fsm-table-scroll::-webkit-scrollbar-thumb:hover,#fsm-top-scroll::-webkit-scrollbar-thumb:hover{background:#9ca3af}.dark #fsm-table-scroll::-webkit-scrollbar-thumb,.dark #fsm-top-scroll::-webkit-scrollbar-thumb{background:#4b5563}.dark #fsm-table-scroll::-webkit-scrollbar-thumb:hover,.dark #fsm-top-scroll::-webkit-scrollbar-thumb:hover{background:#6b7280}"}],"page":{"pagePath":"api-reference/connect/new-session","slug":"/api-reference/connect/new-session","pageMetadata":{"openapi":"post /connect/sessions","title":"Create a new connect session","description":"Create a new connect session for an employer","href":"/api-reference/connect/new-session"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a new connect session for an employer\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`NOTE: The connect session uses Basic Auth; in the sample request above use `,_jsx(_components.code,{children:`client_id`}),` as the username and `,_jsx(_components.code,{children:`client_secret`}),` as a password.\nFor example: `,_jsx(_components.code,{children:`Authorization: Basic \u003cbase64 encoded client_id:client_secret>`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /connect/sessions","title":"Create a new connect session","description":"Create a new connect session for an employer","href":"/api-reference/connect/new-session"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a new connect session","description":"Create a new connect session for an employer","operationId":"post-connect-sessions","tags":["Connect"],"parameters":["e0d96a9a-6f88-4526-82af-221dca3a5db6"],"requestBody":"b8fecffb-b5c8-47c3-bbef-2270d51a4773","security":["a71aa788-0ae5-45c7-9883-1be25820efde"],"responses":{"201":"97a405f9-8362-4a7c-8039-3e7240c2635d","400":"dc6df8a4-f576-44ca-a609-8bc2595693f2","401":"4a25b1da-2787-4ded-934f-ac14d7ca9636"},"x-codeSamples":[{"lang":"JavaScript","source":"import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response.session_id);"},{"lang":"Python","source":"import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get(\"FINCH_CLIENT_ID\"), # This is the default and can be omitted\n client_secret=os.environ.get(\"FINCH_CLIENT_SECRET\"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.new(\n customer_id=\"x\",\n customer_name=\"x\",\n products=[\"benefits\"],\n)\nprint(response.session_id)"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go/v2\"\n\t\"github.com/Finch-API/finch-api-go/v2/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID(\"4ab15e51-11ad-49f4-acae-f343b7794375\"),\n\t\toption.WithClientSecret(\"My Client Secret\"),\n\t)\n\tresponse, err := client.Connect.Sessions.New(context.TODO(), finchgo.ConnectSessionNewParams{\n\t\tCustomerID: finchgo.F(\"x\"),\n\t\tCustomerName: finchgo.F(\"x\"),\n\t\tProducts: finchgo.F([]finchgo.ConnectSessionNewParamsProduct{finchgo.ConnectSessionNewParamsProductBenefits}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.SessionID)\n}\n"},{"lang":"Java","source":"package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectSessionNewParams;\nimport com.tryfinch.api.models.SessionNewResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ConnectSessionNewParams params = ConnectSessionNewParams.builder()\n .customerId(\"x\")\n .customerName(\"x\")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build();\n SessionNewResponse response = client.connect().sessions().new_(params);\n }\n}"},{"lang":"Kotlin","source":"package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectSessionNewParams\nimport com.tryfinch.api.models.SessionNewResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: ConnectSessionNewParams = ConnectSessionNewParams.builder()\n .customerId(\"x\")\n .customerName(\"x\")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build()\n val response: SessionNewResponse = client.connect().sessions().new(params)\n}"},{"lang":"Ruby","source":"require \"finch_api\"\n\nfinch = FinchAPI::Client.new(client_id: \"4ab15e51-11ad-49f4-acae-f343b7794375\", client_secret: \"My Client Secret\")\n\nresponse = finch.connect.sessions.new(customer_id: \"x\", customer_name: \"x\", products: [:benefits])\n\nputs(response)"}],"method":"post","type":"path","servers":["c751b629-e47c-48d2-9131-f14412d7ead8"],"path":"/connect/sessions","baseUrlOptions":["https://api.tryfinch.com"],"title":"Create a new connect session","codeSamples":[{"lang":"JavaScript","source":"import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response.session_id);"},{"lang":"Python","source":"import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get(\"FINCH_CLIENT_ID\"), # This is the default and can be omitted\n client_secret=os.environ.get(\"FINCH_CLIENT_SECRET\"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.new(\n customer_id=\"x\",\n customer_name=\"x\",\n products=[\"benefits\"],\n)\nprint(response.session_id)"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go/v2\"\n\t\"github.com/Finch-API/finch-api-go/v2/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID(\"4ab15e51-11ad-49f4-acae-f343b7794375\"),\n\t\toption.WithClientSecret(\"My Client Secret\"),\n\t)\n\tresponse, err := client.Connect.Sessions.New(context.TODO(), finchgo.ConnectSessionNewParams{\n\t\tCustomerID: finchgo.F(\"x\"),\n\t\tCustomerName: finchgo.F(\"x\"),\n\t\tProducts: finchgo.F([]finchgo.ConnectSessionNewParamsProduct{finchgo.ConnectSessionNewParamsProductBenefits}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.SessionID)\n}\n"},{"lang":"Java","source":"package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectSessionNewParams;\nimport com.tryfinch.api.models.SessionNewResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ConnectSessionNewParams params = ConnectSessionNewParams.builder()\n .customerId(\"x\")\n .customerName(\"x\")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build();\n SessionNewResponse response = client.connect().sessions().new_(params);\n }\n}"},{"lang":"Kotlin","source":"package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectSessionNewParams\nimport com.tryfinch.api.models.SessionNewResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: ConnectSessionNewParams = ConnectSessionNewParams.builder()\n .customerId(\"x\")\n .customerName(\"x\")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build()\n val response: SessionNewResponse = client.connect().sessions().new(params)\n}"},{"lang":"Ruby","source":"require \"finch_api\"\n\nfinch = FinchAPI::Client.new(client_id: \"4ab15e51-11ad-49f4-acae-f343b7794375\", client_secret: \"My Client Secret\")\n\nresponse = finch.connect.sessions.new(customer_id: \"x\", customer_name: \"x\", products: [:benefits])\n\nputs(response)"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"e0d96a9a-6f88-4526-82af-221dca3a5db6":{"name":"Finch-API-Version","in":"header","required":true,"schema":{"type":"string","default":"2020-09-17","format":"date","isRequired":true,"description":"Header used to specify the version for a given API request. Current version is 2020-09-17.","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"Header used to specify the version for a given API request. Current version is 2020-09-17.","x-stainless-param":false}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","minLength":1,"maxLength":255,"description":"Unique identifier for the customer","isRequired":true,"uniqueKey":"customer_id","typeLabel":"string"},"customer_name":{"type":"string","minLength":1,"maxLength":255,"description":"Name of the customer","isRequired":true,"uniqueKey":"customer_name","typeLabel":"string"},"products":{"type":"array","items":{"type":"string","enum":["benefits","company","deduction","directory","documents","employment","individual","payment","pay_statement","plans","plans_dependents","plans_enrollments","recordkeeping","ssn"],"uniqueKey":"products.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"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`.","isRequired":true,"uniqueKey":"products","typeLabel":"enum\u003cstring>[]"},"customer_email":{"oneOf":[{"type":"string","format":"email","description":"Email address of the customer","uniqueKey":"customer_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","description":"Email address of the customer","uniqueKey":"customer_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer_email","typeLabel":"string\u003cemail> | null"},"redirect_uri":{"oneOf":[{"type":"string","description":"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).","uniqueKey":"redirect_uri.oneOf.0","typeLabel":"string"},{"type":"null","description":"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).","uniqueKey":"redirect_uri.oneOf.1","typeLabel":"null"}],"uniqueKey":"redirect_uri","typeLabel":"string | null"},"minutes_to_expire":{"oneOf":[{"type":"number","minimum":1,"maximum":129600,"description":"The number of minutes until the session expires (defaults to 129,600, which is 90 days)","uniqueKey":"minutes_to_expire.oneOf.0","typeLabel":"number"},{"type":"null","minimum":1,"maximum":129600,"description":"The number of minutes until the session expires (defaults to 129,600, which is 90 days)","uniqueKey":"minutes_to_expire.oneOf.1","typeLabel":"null"}],"uniqueKey":"minutes_to_expire","typeLabel":"number | null"},"sandbox":{"oneOf":[{"type":"string","enum":["finch","provider",null],"description":"Sandbox mode for testing","uniqueKey":"sandbox.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["finch","provider",null],"description":"Sandbox mode for testing","uniqueKey":"sandbox.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox","typeLabel":"enum\u003cstring> | null"},"manual":{"oneOf":[{"type":"boolean","description":"Enable manual authentication mode","uniqueKey":"manual.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable manual authentication mode","uniqueKey":"manual.oneOf.1","typeLabel":"null"}],"uniqueKey":"manual","typeLabel":"boolean | null"},"integration":{"oneOf":[{"type":"object","properties":{"provider":{"type":"string","description":"The provider to integrate with","isRequired":true,"uniqueKey":"integration.oneOf.0.provider","typeLabel":"string"},"auth_method":{"oneOf":[{"type":"string","enum":["assisted","credential","oauth","api_token",null],"description":"The authentication method to use","uniqueKey":"integration.oneOf.0.auth_method.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["assisted","credential","oauth","api_token",null],"description":"The authentication method to use","uniqueKey":"integration.oneOf.0.auth_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"integration.oneOf.0.auth_method","typeLabel":"enum\u003cstring> | null"}},"required":["provider"],"description":"Integration configuration for the connect session","uniqueKey":"integration.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"provider":{"type":"string","description":"The provider to integrate with"},"auth_method":{"oneOf":[{"type":"string","enum":["assisted","credential","oauth","api_token",null],"description":"The authentication method to use"},{"type":"null","enum":["assisted","credential","oauth","api_token",null],"description":"The authentication method to use"}]}},"required":["provider"],"description":"Integration configuration for the connect session","uniqueKey":"integration.oneOf.1","typeLabel":"null"}],"uniqueKey":"integration","typeLabel":"object | null"},"recordkeeping":{"oneOf":[{"type":"object","properties":{"recordkeeper":{"type":"string","enum":["voya","empower","fidelity","transamerica"],"description":"The recordkeeper to configure for this connection","isRequired":true,"uniqueKey":"recordkeeping.oneOf.0.recordkeeper","typeLabel":"enum\u003cstring>"},"plan_id":{"oneOf":[{"type":"string","minLength":1,"description":"The plan identifier used by the recordkeeper","uniqueKey":"recordkeeping.oneOf.0.plan_id.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"description":"The plan identifier used by the recordkeeper","uniqueKey":"recordkeeping.oneOf.0.plan_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"recordkeeping.oneOf.0.plan_id","typeLabel":"string | null"}},"required":["recordkeeper"],"description":"Optional recordkeeping configuration. Can only be provided when the `recordkeeping` product is requested. Currently supports `recordkeeper` set to `voya`, `empower`, `fidelity`, or `transamerica`.","uniqueKey":"recordkeeping.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"plan_id":{"oneOf":[{"type":"string","minLength":1,"description":"The plan identifier used by the recordkeeper"},{"type":"null","minLength":1,"description":"The plan identifier used by the recordkeeper"}]},"recordkeeper":{"type":"string","enum":["voya","empower","fidelity","transamerica"],"description":"The recordkeeper to configure for this connection"}},"required":["recordkeeper"],"description":"Optional recordkeeping configuration. Can only be provided when the `recordkeeping` product is requested. Currently supports `recordkeeper` set to `voya`, `empower`, `fidelity`, or `transamerica`.","uniqueKey":"recordkeeping.oneOf.1","typeLabel":"null"}],"uniqueKey":"recordkeeping","typeLabel":"object | null"}},"required":["customer_id","customer_name","products"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customer_id":"\u003cstring>","customer_name":"\u003cstring>","products":[],"customer_email":"jsmith@example.com","redirect_uri":"\u003cstring>","minutes_to_expire":64800.5,"manual":true,"integration":{"provider":"\u003cstring>"},"recordkeeping":{"plan_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"97a405f9-8362-4a7c-8039-3e7240c2635d":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"session_id":{"type":"string","description":"The unique identifier for the created connect session","isRequired":true,"uniqueKey":"session_id","typeLabel":"string"},"connect_url":{"type":"string","format":"uri","description":"The Connect URL to redirect the user to for authentication","isRequired":true,"uniqueKey":"connect_url","typeLabel":"string\u003curi>"}},"required":["session_id","connect_url"],"uniqueKey":"","typeLabel":"object"},"examples":{"Success":{"title":"Success","value":{"session_id":"550e8400-e29b-41d4-a716-446655440000","connect_url":"https://connect.tryfinch.com/authorize?session=550e8400-e29b-41d4-a716-446655440000"}}},"exampleType":"examples"}},"exampleType":"examples"},"dc6df8a4-f576-44ca-a609-8bc2595693f2":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":400,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"finch_code":{"type":"string","enum":["connection_already_exists","invalid_request"],"example":"connection_already_exists","isRequired":true,"uniqueKey":"finch_code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"There's an existing connection for the customer_id: {customer_id}. Please use the /connect/sessions/reauthenticate endpoint instead.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"name":{"type":"string","example":"bad_request","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"context":{"type":"object","properties":{"customer_id":{"type":"string","uniqueKey":"context.customer_id","typeLabel":"string"},"connection_id":{"type":"string","uniqueKey":"context.connection_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"context","typeLabel":"object"}},"required":["code","finch_code","message","name","context"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":400,"finch_code":"connection_already_exists","message":"There's an existing connection for the customer_id: {customer_id}. Please use the /connect/sessions/reauthenticate endpoint instead.","name":"bad_request","context":{"customer_id":"\u003cstring>","connection_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"4a25b1da-2787-4ded-934f-ac14d7ca9636":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","example":401,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"finch_code":{"type":"string","example":"invalid_client","isRequired":true,"uniqueKey":"finch_code","typeLabel":"string"},"message":{"type":"string","example":"Invalid client: Unable to validate credentials","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","finch_code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":401,"finch_code":"invalid_client","message":"Invalid client: Unable to validate credentials"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a71aa788-0ae5-45c7-9883-1be25820efde":{"basicAuth":{"type":"http","scheme":"basic","description":"Please use base64 encoded client_id:client_secret","scopes":[],"schemeName":"basicAuth"}}},"servers":{"c751b629-e47c-48d2-9131-f14412d7ead8":{"url":"https://api.tryfinch.com","description":""}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Please use base64 encoded client_id:client_secret","scopes":[],"schemeName":"basicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Please use base64 encoded client_id:client_secret","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"finch","siteName":"Finch","title":"Create a new connect session - Finch","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-15T15:44:25.845Z","originalFileLocation":"api-reference/connect/new-session.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a new connect session for an employer\">\u003cmeta data-mint-head name=\"application-name\" content=\"Finch\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/finch/uhsSWlAJd6T26wSS/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/finch/uhsSWlAJd6T26wSS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/finch/uhsSWlAJd6T26wSS/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/finch/uhsSWlAJd6T26wSS/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/finch/uhsSWlAJd6T26wSS/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/finch/uhsSWlAJd6T26wSS/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/finch/uhsSWlAJd6T26wSS/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/finch/uhsSWlAJd6T26wSS/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/finch/uhsSWlAJd6T26wSS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a new connect session - Finch\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new connect session for an employer\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Finch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.tryfinch.com/api-reference/connect/new-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://finch.mintlify.app/_mintlify/api/og/v2?division=Connect\u0026amp;title=Create+a+new+connect+session\u0026amp;description=Create+a+new+connect+session+for+an+employer\u0026amp;theme=833c5e58755e897492517fe7\u0026amp;signature=4e59fc4ac660c0d311e3800b16c63b134c9be17c5b57600485110eb1b2ef3ab8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a new connect session - Finch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new connect session for an employer\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://finch.mintlify.app/_mintlify/api/og/v2?division=Connect\u0026amp;title=Create+a+new+connect+session\u0026amp;description=Create+a+new+connect+session+for+an+employer\u0026amp;theme=833c5e58755e897492517fe7\u0026amp;signature=4e59fc4ac660c0d311e3800b16c63b134c9be17c5b57600485110eb1b2ef3ab8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/finch/uhsSWlAJd6T26wSS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Finch\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#161616\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.tryfinch.com/api-reference/connect/new-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/connect/new-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.tryfinch.com/#organization\",\"name\":\"Finch\",\"url\":\"https://developer.tryfinch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/finch/ejF2Kw2CeeMQKCJw/logo/logo-black.svg?fit=max\u0026auto=format\u0026n=ejF2Kw2CeeMQKCJw\u0026q=85\u0026s=e490dba98fb7b16e8f9f5ab4a9a58a5c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.tryfinch.com#website\",\"name\":\"Finch\",\"url\":\"https://developer.tryfinch.com\",\"publisher\":{\"@id\":\"https://developer.tryfinch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.tryfinch.com/api-reference/connect/new-session#webpage\",\"url\":\"https://developer.tryfinch.com/api-reference/connect/new-session\",\"name\":\"Create a new connect session\",\"description\":\"Create a new connect session for an employer\",\"dateModified\":\"2025-09-15T15:44:25.845Z\",\"isPartOf\":{\"@id\":\"https://developer.tryfinch.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.tryfinch.com/api-reference/connect/new-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.tryfinch.com/api-reference/connect/new-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Finch\",\"item\":\"https://developer.tryfinch.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a new connect session\",\"item\":\"https://developer.tryfinch.com/api-reference/connect/new-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.tryfinch.com/api-reference/connect/new-session#apireference\",\"headline\":\"Create a new connect session\",\"name\":\"Create a new connect session\",\"description\":\"Create a new connect session for an employer\",\"url\":\"https://developer.tryfinch.com/api-reference/connect/new-session\",\"mainEntityOfPage\":{\"@id\":\"https://developer.tryfinch.com/api-reference/connect/new-session#webpage\"},\"dateModified\":\"2025-09-15T15:44:25.845Z\",\"publisher\":{\"@id\":\"https://developer.tryfinch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.tryfinch.com#website\"}}]}\u003c/script>","siteName":"Finch","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":{"style":"sharp-solid","name":"megaphone"},"color":{"light":"#3E4AE7","dark":"#3E4AE7"},"href":"https://developer.tryfinch.com/changelog"},{"anchor":"API Status","icon":{"style":"sharp-solid","name":"signal-bars"},"color":{"light":"#3E4AE7","dark":"#3E4AE7"},"href":"https://status.tryfinch.com"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/how-finch-works/quickstart"}]},{"tab":"API Reference","groups":[{"group":"Organization","pages":[{"openapi":"get /employer/company","title":"Company","href":"/api-reference/organization/company"},{"openapi":"get /employer/directory","title":"Directory","href":"/api-reference/organization/directory"},{"openapi":"post /employer/individual","title":"Individual","href":"/api-reference/organization/individual"},{"openapi":"post /employer/employment","title":"Employment","href":"/api-reference/organization/employment"}]},{"group":"Payroll","pages":[{"openapi":"get /employer/payment","title":"Payment","href":"/api-reference/payroll/payment"},{"openapi":"post /employer/pay-statement","title":"Pay Statement","href":"/api-reference/payroll/pay-statement"},{"openapi":"get /employer/pay-statement-item","title":"Pay Statement Item","href":"/api-reference/payroll/get-pay-statement-items"},{"group":"Rules","pages":[{"openapi":"post /employer/pay-statement-item/rule","title":"Create Rule","href":"/api-reference/payroll/create-rule"},{"openapi":"get /employer/pay-statement-item/rule","title":"Get Rules","href":"/api-reference/payroll/get-rules"},{"openapi":"put /employer/pay-statement-item/rule/{rule_id}","title":"Update Rule","href":"/api-reference/payroll/update-rule"},{"openapi":"delete /employer/pay-statement-item/rule/{rule_id}","title":"Delete Rule","href":"/api-reference/payroll/delete-rule"}]},{"openapi":"get /employer/pay-groups","title":"Get All Pay Groups","href":"/api-reference/payroll/get-pay-groups"},{"openapi":"get /employer/pay-groups/{pay_group_id}","title":"Get Pay Group","href":"/api-reference/payroll/get-pay-group"},{"openapi":"post /employer/ledger-items","title":"Ledger Items","href":"/api-reference/payroll/get-ledger-items"}]},{"group":"Deductions","pages":[{"openapi":"get /employer/benefits","title":"Get All Deductions","href":"/api-reference/deductions/get-all-deductions"},{"openapi":"post /employer/benefits/register","title":"Register Deduction","href":"/api-reference/deductions/register-deduction"},{"openapi":"post /employer/benefits","title":"Create Deduction","href":"/api-reference/deductions/create-deduction"},{"openapi":"get /employer/benefits/{benefit_id}","title":"Get Deduction","href":"/api-reference/deductions/get-deduction"},{"openapi":"post /employer/benefits/{benefit_id}","title":"Update Deduction","href":"/api-reference/deductions/update-deduction"},{"openapi":"get /employer/benefits/{benefit_id}/enrolled","title":"Get Enrolled Individuals","href":"/api-reference/deductions/get-enrolled-individuals"},{"openapi":"get /employer/benefits/{benefit_id}/individuals","title":"Get Deductions for Individuals","href":"/api-reference/deductions/get-deductions-for-individuals"},{"openapi":"post /employer/benefits/{benefit_id}/individuals","title":"Enroll Individuals in Deductions","href":"/api-reference/deductions/enroll-individuals-in-deductions"},{"openapi":"delete /employer/benefits/{benefit_id}/individuals","title":"Unenroll Individuals from Deductions","href":"/api-reference/deductions/unenroll-individuals-from-deductions"}]},{"group":"Benefits","pages":[{"openapi":"get /employer/plans","title":"List Plans","href":"/api-reference/benefits/list-plans"},{"openapi":"get /employer/plans/{plan_id}","title":"Get Plan","href":"/api-reference/benefits/get-plan"},{"openapi":"get /employer/plans-enrollments","title":"List Enrollments","href":"/api-reference/benefits/list-plan-enrollments"},{"openapi":"post /employer/plans-enrollments","title":"Get Enrollments","href":"/api-reference/benefits/get-plan-enrollments"},{"openapi":"get /employer/plans-dependents","title":"List Dependents","href":"/api-reference/benefits/list-plan-dependents"},{"openapi":"post /employer/plans-dependents","title":"Get Dependents","href":"/api-reference/benefits/get-plan-dependents"}]},{"group":"Documents","pages":[{"openapi":"get /employer/documents","title":"List Documents","href":"/api-reference/documents/get-documents"},{"openapi":"get /employer/documents/{document_id}","title":"Get Document","description":"**Beta:** This endpoint is in beta and may change.\nRetrieve details of a specific document by its ID.\n","href":"/api-reference/documents/get-document"}]},{"group":"Connect","pages":[{"openapi":"post /connect/sessions","title":"Create a new connect session","href":"/api-reference/connect/new-session"},{"openapi":"post /connect/sessions/reauthenticate","title":"Create a new Connect session for reauthentication","description":"Create a new Connect session for reauthenticating an existing connection","href":"/api-reference/connect/reauthenticate-session"}]},{"group":"Management","pages":[{"openapi":"post /auth/token","title":"Create Access Token","href":"/api-reference/management/create-access-token"},{"openapi":"get /providers","title":"Providers","href":"/api-reference/management/providers"},{"openapi":"get /introspect","title":"Introspect","href":"/api-reference/management/introspect"},{"openapi":"post /disconnect","title":"Disconnect","href":"/api-reference/management/disconnect"},{"openapi":"post /disconnect-entity","title":"Disconnect Entity","href":"/api-reference/management/disconnect-entity"},{"openapi":"post /forward","title":"Request Forwarding","href":"/api-reference/management/request-forwarding"},{"openapi":"get /jobs/automated","title":"List All Automated Jobs","href":"/api-reference/management/list-all-automated-jobs"},{"openapi":"post /jobs/automated","title":"Enqueue a New Automated Job","href":"/api-reference/management/enqueue-a-new-automated-job"},{"openapi":"get /jobs/automated/{job_id}","title":"Retrieve an Automated Job","href":"/api-reference/management/retrieve-an-automated-job"},{"openapi":"get /jobs/manual/{job_id}","title":"Retrieve a Manual Job","href":"/api-reference/management/retrieve-a-manual-job"}]},{"group":"Sandbox","pages":[{"openapi":"post /sandbox/connections","title":"Create a new Sandbox Connection","href":"/api-reference/sandbox/create-sandbox-connection"},{"openapi":"post /sandbox/connections/accounts","title":"Create a new sandbox account","href":"/api-reference/sandbox/create-sandbox-account"},{"openapi":"put /sandbox/connections/accounts","title":"Update a sandbox account","href":"/api-reference/sandbox/update-sandbox-account"},{"openapi":"get /sandbox/jobs/configuration","title":"Get configurations for sandbox jobs","href":"/api-reference/sandbox/get-sandbox-jobs-configuration"},{"openapi":"put /sandbox/jobs/configuration","title":"Update configurations for sandbox jobs","href":"/api-reference/sandbox/update-sandbox-jobs-configuration"},{"openapi":"post /sandbox/payment","title":"Add a new sandbox payment","href":"/api-reference/sandbox/create-sandbox-payment"},{"openapi":"put /sandbox/individual/{individual_id}","title":"Update sandbox individual","href":"/api-reference/sandbox/update-sandbox-individual"},{"openapi":"put /sandbox/employment/{individual_id}","title":"Update sandbox employment","href":"/api-reference/sandbox/update-sandbox-employment"},{"openapi":"post /sandbox/directory","title":"Add new individuals to a sandbox company","href":"/api-reference/sandbox/create-sandbox-employee"},{"openapi":"put /sandbox/company","title":"Update a sandbox company's data","href":"/api-reference/sandbox/update-sandbox-company"},{"openapi":"post /sandbox/jobs","title":"Enqueue a new sandbox job","href":"/api-reference/sandbox/refresh-job"}]},{"group":"Development Guides","pages":[{"title":"Permissions","href":"/api-reference/development-guides/Permissions"},{"title":"Headers","href":"/api-reference/development-guides/Headers"},{"title":"API Versioning","href":"/api-reference/development-guides/Versioning"},{"title":"Rate Limits","href":"/api-reference/development-guides/Rate-Limits"},{"title":"Handling API Responses","href":"/api-reference/development-guides/Handling-API-Responses"},{"group":"Errors","pages":[{"title":"Error Handling","href":"/api-reference/development-guides/errors/Error-Handling"},{"title":"Error Types","href":"/api-reference/development-guides/errors/Error-Types"}]}]}]}]},"basePath":"","title":"Create a new connect session - Finch","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}