The Forward API allows you to make direct requests to an employment system. If Finch’s unified API
doesn’t have a data model that cleanly fits your needs, then Forward allows you to push or pull
data models directly against an integration’s API.
The Forward API allows you to make direct requests to an employment system. If Finch’s unified API
doesn’t have a data model that cleanly fits your needs, then Forward allows you to push or pull
data models directly against an integration’s API.
The URL route path for the forwarded request. This value must begin with a forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and underscores.
The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: {"Content-Type": "application/xml", "X-API-Version": "v1" }
The HTTP status code of the forwarded request's response, exactly received from the underlying integration's API. This value will be returned as an integer.
A string representation of the HTTP response body of the forwarded request's response received from the underlying integration's API. This field may be null in the case where the upstream system's response is empty.
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":""},"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":"6aeb5f87e84fb046db8c951b","clientVersion":"0.0.4094","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":"custom-rbac-roles","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":"rbac-expansion","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":"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":"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":"editor-metadata","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":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","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, 0.08)!important;color:var(--finch-purple)!important}.dark .update-container [class*=\"bg-primary\"]{background-color:rgba(122, 132, 255, 0.15)!important;color:var(--finch-purple-dark)!important}#content-side-layout:empty{position:absolute}#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:none;background:#fff;color:#101828;transition:border-color 0.15s, box-shadow 0.15s}.pn-search:focus{border-color:var(--finch-purple);box-shadow:0 0 0 3px rgba(62, 74, 231, 0.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, 0.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{font-size:13px;font-weight:600;color:#475467;margin-right:2px;white-space:nowrap}.dark .pn-filter-label{color:#98A2B3}.pn-checkbox-label{display:flex;align-items:center;gap:6px;font-size:13px;font-weight:500;color:#344054;cursor:pointer}.dark .pn-checkbox-label{color:#D0D5DD}.pn-export-btn{display:inline-flex;align-items:center;gap:6px;padding:4px 12px;border:1px solid #D0D5DD;border-radius:6px;background:transparent;font-size:13px;font-weight:500;color:#475467;cursor:pointer;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{display:inline-flex;align-items:center;padding:4px 12px;font-size:13px;font-weight:500;border:1px solid #D0D5DD;border-radius:999px;background:#fff;color:#344054;cursor:pointer;transition:all 0.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}.pn-table td,.pn-table th{min-width:0!important}.pn-col-narrow{width:1%!important}.pn-th-center,.pn-td-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-weight:600;font-size:12px;text-transform:uppercase;letter-spacing:0.04em;color:#475467;border-bottom:2px solid #E4E7EC;white-space:nowrap}.dark .pn-table thead th{color:#98A2B3;border-bottom-color:#344054}.pn-table tbody tr{border-bottom:1px solid #F2F4F7;transition:background 0.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 th:first-child,.pn-table td: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{display:inline-flex;align-items:center;gap:6px}.pn-id-cell{display:inline-flex;align-items:center;gap:4px}.pn-id-cell code{font-size:12px}.pn-copy-btn{display:inline-flex;align-items:center;justify-content:center;background:none;border:none;cursor:pointer;color:#98A2B3;padding:2px;border-radius:4px;transition:color 0.15s, background 0.15s}.pn-copy-btn:hover{color:var(--finch-purple);background:#F2F4F7}.dark .pn-copy-btn:hover{color:var(--finch-purple-dark);background:#344054}.pn-badge-assisted-fast,.assisted-fast-badge,.pn-badge-automated,.pn-badge-assisted{display:inline-block;padding:1px 6px;border-radius:999px;font-size:11px;font-weight:500;white-space:nowrap}.pn-badge-assisted-fast,.assisted-fast-badge{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-ga,.pn-status-beta{display:inline-block;padding:1px 6px;border-radius:999px;font-size:10px;font-weight:600;letter-spacing:0.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-oauth,.fsm-auth-credential,.fsm-auth-api_token,.fsm-auth-assisted{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{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:0.02em;flex-shrink:0}.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{display:inline-flex;align-items:center;gap:6px;padding:7px 12px;border:1px solid #e2e8f0;border-radius:8px;background:transparent;font-size:13px;font-weight:500;color:#64748b;cursor:pointer}.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;align-items:center;gap:8px;width:100%;padding:5px 10px;border:none;font-size:13px;border-radius:6px;cursor:pointer;text-align:left;background:transparent;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,0.08)}.dark .fsm-drop-item-selected{background:rgba(122,132,255,0.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,0.15);z-index:100;pointer-events:none}.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-btn-tooltip-wrap:hover .fsm-btn-tooltip{display:block}.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-tip:hover .fsm-tip-text{display:block}#fsm-table-scroll,#fsm-top-scroll{margin-left:0!important;margin-right:0!important;max-width:100%!important}#fsm-table-scroll table td,#fsm-table-scroll table th{min-width:0!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:transparent}#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/management/forward","slug":"/api-reference/management/forward","pageMetadata":{"openapi":"post /forward","title":"Request Forwarding","description":"The Forward API allows you to make direct requests to an employment system. If Finch's unified API\ndoesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration's API.","href":"/api-reference/management/forward"},"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: \"The Forward API allows you to make direct requests to an employment system. If Finch’s unified API\\ndoesn’t have a data model that cleanly fits your needs, then Forward allows you to push or pull\\ndata models directly against an integration’s API.\"\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`The Forward API allows you to make direct requests to an employment system. If Finch’s unified API\ndoesn’t have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration’s API.`})}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 /forward","title":"Request Forwarding","description":"The Forward API allows you to make direct requests to an employment system. If Finch's unified API\ndoesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration's API.","href":"/api-reference/management/forward"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Request Forwarding","operationId":"post-forward","description":"The Forward API allows you to make direct requests to an employment system. If Finch's unified API\ndoesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration's API.","tags":["Management"],"parameters":["d8de93e2-c0e7-4cd0-9cb4-8714b853a7a8"],"requestBody":"23397861-aad4-4ed6-a9a1-f8eb484fe600","security":["84db5441-3fd4-4389-98cc-4df332cad9e2"],"responses":{"200":"58a8fe38-1cd8-406a-b46d-188d1dca8d40"},"x-codeSamples":[{"lang":"JavaScript","source":"import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response.request);"},{"lang":"Python","source":"from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nresponse = client.request_forwarding.forward(\n method=\"method\",\n route=\"route\",\n)\nprint(response.request)"},{"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.WithAccessToken(\"My Access Token\"),\n\t)\n\tresponse, err := client.RequestForwarding.Forward(context.TODO(), finchgo.RequestForwardingForwardParams{\n\t\tMethod: finchgo.F(\"method\"),\n\t\tRoute: finchgo.F(\"route\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.Request)\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.RequestForwardingForwardParams;\nimport com.tryfinch.api.models.RequestForwardingForwardResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n RequestForwardingForwardParams params = RequestForwardingForwardParams.builder()\n .method(\"method\")\n .route(\"route\")\n .build();\n RequestForwardingForwardResponse response = client.requestForwarding().forward(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.RequestForwardingForwardParams\nimport com.tryfinch.api.models.RequestForwardingForwardResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: RequestForwardingForwardParams = RequestForwardingForwardParams.builder()\n .method(\"method\")\n .route(\"route\")\n .build()\n val response: RequestForwardingForwardResponse = client.requestForwarding().forward(params)\n}"},{"lang":"Ruby","source":"require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nresponse = finch.request_forwarding.forward(method_: \"method\", route: \"route\")\n\nputs(response)"}],"method":"post","type":"path","servers":["e36ac43a-0e97-452c-aef7-f8b3c2e6e57e"],"path":"/forward","baseUrlOptions":["https://api.tryfinch.com"],"title":"Request Forwarding","codeSamples":[{"lang":"JavaScript","source":"import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response.request);"},{"lang":"Python","source":"from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nresponse = client.request_forwarding.forward(\n method=\"method\",\n route=\"route\",\n)\nprint(response.request)"},{"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.WithAccessToken(\"My Access Token\"),\n\t)\n\tresponse, err := client.RequestForwarding.Forward(context.TODO(), finchgo.RequestForwardingForwardParams{\n\t\tMethod: finchgo.F(\"method\"),\n\t\tRoute: finchgo.F(\"route\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.Request)\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.RequestForwardingForwardParams;\nimport com.tryfinch.api.models.RequestForwardingForwardResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n RequestForwardingForwardParams params = RequestForwardingForwardParams.builder()\n .method(\"method\")\n .route(\"route\")\n .build();\n RequestForwardingForwardResponse response = client.requestForwarding().forward(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.RequestForwardingForwardParams\nimport com.tryfinch.api.models.RequestForwardingForwardResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: RequestForwardingForwardParams = RequestForwardingForwardParams.builder()\n .method(\"method\")\n .route(\"route\")\n .build()\n val response: RequestForwardingForwardResponse = client.requestForwarding().forward(params)\n}"},{"lang":"Ruby","source":"require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nresponse = finch.request_forwarding.forward(method_: \"method\", route: \"route\")\n\nputs(response)"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"d8de93e2-c0e7-4cd0-9cb4-8714b853a7a8":{"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":{"method":{"type":"string","description":"The HTTP method for the forwarded request. Valid values include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.","isRequired":true,"uniqueKey":"method","typeLabel":"string"},"route":{"type":"string","description":"The URL route path for the forwarded request. This value must begin with a forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and underscores.","isRequired":true,"uniqueKey":"route","typeLabel":"string"},"params":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"params.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"params.oneOf.0.additionalProperties","typeLabel":"null"},"description":"The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.","uniqueKey":"params.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"params.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"params.oneOf.1.additionalProperties","typeLabel":"null"},"description":"The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.","uniqueKey":"params.oneOf.1","typeLabel":"null"}],"uniqueKey":"params","typeLabel":"object | null"},"data":{"oneOf":[{"type":"string","description":"The body for the forwarded request. This value must be specified as either a string or a valid JSON object.","uniqueKey":"data.oneOf.0","typeLabel":"string"},{"type":"null","description":"The body for the forwarded request. This value must be specified as either a string or a valid JSON object.","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"string | null"},"request_headers":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"request_headers.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"request_headers.oneOf.0.additionalProperties","typeLabel":"null"},"description":"The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: `{\"Content-Type\": \"application/xml\", \"X-API-Version\": \"v1\" }`","uniqueKey":"request_headers.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"request_headers.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"request_headers.oneOf.1.additionalProperties","typeLabel":"null"},"description":"The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: `{\"Content-Type\": \"application/xml\", \"X-API-Version\": \"v1\" }`","uniqueKey":"request_headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"request_headers","typeLabel":"object | null"}},"required":["method","route"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"method":"\u003cstring>","route":"\u003cstring>","params":{},"data":"\u003cstring>","request_headers":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"58a8fe38-1cd8-406a-b46d-188d1dca8d40":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status code of the forwarded request's response, exactly received from the underlying integration's API. This value will be returned as an integer.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"request":{"type":"object","properties":{"method":{"type":"string","description":"The HTTP method that was specified for the forwarded request. Valid values include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.","isRequired":true,"uniqueKey":"request.method","typeLabel":"string"},"route":{"type":"string","description":"The URL route path that was specified for the forwarded request.","isRequired":true,"uniqueKey":"request.route","typeLabel":"string"},"headers":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"request.headers.oneOf.0.additionalProperties","typeLabel":"string"},"description":"The HTTP headers that were specified for the forwarded request.","uniqueKey":"request.headers.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"request.headers.oneOf.1.additionalProperties","typeLabel":"string"},"description":"The HTTP headers that were specified for the forwarded request.","uniqueKey":"request.headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"request.headers","typeLabel":"object | null"},"params":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"request.params.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"request.params.oneOf.0.additionalProperties","typeLabel":"null"},"description":"The query parameters that were specified for the forwarded request.","uniqueKey":"request.params.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"request.params.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"request.params.oneOf.1.additionalProperties","typeLabel":"null"},"description":"The query parameters that were specified for the forwarded request.","uniqueKey":"request.params.oneOf.1","typeLabel":"null"}],"uniqueKey":"request.params","typeLabel":"object | null"},"data":{"oneOf":[{"type":"string","description":"The body that was specified for the forwarded request.","uniqueKey":"request.data.oneOf.0","typeLabel":"string"},{"type":"object","description":"The body that was specified for the forwarded request.","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"request.data.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"request.data.oneOf.1.additionalProperties","typeLabel":"null"},"uniqueKey":"request.data.oneOf.1","typeLabel":"object"},{"description":"The body that was specified for the forwarded request.","uniqueKey":"request.data.oneOf.2","typeLabel":"any"},{"type":"null","description":"The body that was specified for the forwarded request.","uniqueKey":"request.data.oneOf.3","typeLabel":"null"},{"description":"The body that was specified for the forwarded request.","uniqueKey":"request.data.oneOf.4","typeLabel":"any"},{"type":"null","description":"The body that was specified for the forwarded request.","uniqueKey":"request.data.oneOf.5","typeLabel":"null"}],"uniqueKey":"request.data","typeLabel":"string · object · any · null · any · null"}},"required":["method","route"],"description":"An object containing details of your original forwarded request, for your ease of reference.","isRequired":true,"uniqueKey":"request","typeLabel":"object"},"headers":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"headers.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"headers.oneOf.0.additionalProperties","typeLabel":"null"},"description":"The HTTP headers of the forwarded request's response, exactly as received from the underlying integration's API.","uniqueKey":"headers.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"headers.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"headers.oneOf.1.additionalProperties","typeLabel":"null"},"description":"The HTTP headers of the forwarded request's response, exactly as received from the underlying integration's API.","uniqueKey":"headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"headers","typeLabel":"object | null"},"data":{"oneOf":[{"type":"string","description":"A string representation of the HTTP response body of the forwarded request's response received from the underlying integration's API. This field may be null in the case where the upstream system's response is empty.","uniqueKey":"data.oneOf.0","typeLabel":"string"},{"type":"null","description":"A string representation of the HTTP response body of the forwarded request's response received from the underlying integration's API. This field may be null in the case where the upstream system's response is empty.","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"string | null"}},"required":["statusCode","request"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":123,"request":{"method":"\u003cstring>","route":"\u003cstring>","headers":{},"params":{},"data":"\u003cstring>"},"headers":{},"data":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"84db5441-3fd4-4389-98cc-4df332cad9e2":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Please use your Access Token","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"e36ac43a-0e97-452c-aef7-f8b3c2e6e57e":{"url":"https://api.tryfinch.com","description":"Finch production environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Please use your Access Token","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Please use your Access Token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"finch","siteName":"Finch","title":"Request Forwarding - Finch","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-24T01:10:54.082Z","originalFileLocation":"api-reference/management/forward.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=\"The Forward API allows you to make direct requests to an employment system. If Finch\u0026#x27;s unified API doesn\u0026#x27;t have a data model that cleanly fits your needs, then Forward allows you to push or pull data models directly against an integration\u0026#x27;s API.\">\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=\"Request Forwarding - Finch\">\u003cmeta data-mint-head property=\"og:description\" content=\"The Forward API allows you to make direct requests to an employment system. If Finch\u0026#x27;s unified API doesn\u0026#x27;t have a data model that cleanly fits your needs, then Forward allows you to push or pull data models directly against an integration\u0026#x27;s API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Finch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.tryfinch.com/api-reference/management/forward\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://finch.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Request+Forwarding\u0026amp;description=The+Forward+API+allows+you+to+make+direct+requests+to+an+employment+system.+If+Finch%27s+unified+API%0Adoesn%27t+have+a+data+model+that+cleanly+fits+your+needs%2C+then+\u0026amp;theme=118a57468f2a5083081331a7\u0026amp;signature=411fd555f0d79b74d091fb00f84f233786b1a34ad3ad36b9dad798789105eb16\">\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=\"Request Forwarding - Finch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The Forward API allows you to make direct requests to an employment system. If Finch\u0026#x27;s unified API doesn\u0026#x27;t have a data model that cleanly fits your needs, then Forward allows you to push or pull data models directly against an integration\u0026#x27;s API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://finch.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Request+Forwarding\u0026amp;description=The+Forward+API+allows+you+to+make+direct+requests+to+an+employment+system.+If+Finch%27s+unified+API%0Adoesn%27t+have+a+data+model+that+cleanly+fits+your+needs%2C+then+\u0026amp;theme=118a57468f2a5083081331a7\u0026amp;signature=411fd555f0d79b74d091fb00f84f233786b1a34ad3ad36b9dad798789105eb16\">\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/management/forward\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/management/forward.md\">","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","groups":[{"group":"How Finch Works","pages":[{"title":"Quickstart","href":"/how-finch-works/quickstart"},{"title":"What is Finch?","href":"/how-finch-works/finch-overview"},{"title":"How the Finch API is organized","sidebarTitle":"Data model","href":"/how-finch-works/data-model"},{"title":"Connect an Employer","href":"/how-finch-works/finch-connect"},{"title":"Unified API Glossary","sidebarTitle":"Glossary","href":"/how-finch-works/unified-employment-api-glossary"}]},{"group":"Integrations","pages":[{"title":"Integration Types","href":"/integrations/integration-types"},{"title":"Provider Network","href":"/integrations/providers"},{"title":"Field Support","mode":"wide","href":"/integrations/field-support"},{"title":"Provider Setup Instructions","href":"/integrations/provider-setup"}]},{"group":"Products","pages":[{"title":"Organization","href":"/products/organization/Overview"},{"title":"Payroll","href":"/products/payroll/Overview"},{"title":"Deductions","href":"/products/deductions/Overview"},{"title":"Benefits","href":"/products/benefits/Overview"},{"title":"Recordkeeper","href":"/products/recordkeeper/Overview"},{"title":"Documents","href":"/products/documents/Overview"}]},{"group":"Implementation Guide","pages":[{"title":"Implementation with Finch","href":"/implementation-guide/go-live-checklist"},{"group":"Implement Finch Connect","pages":[{"title":"Create a Finch Developer Account","href":"/implementation-guide/Connect/Create-Account"},{"title":"Create a Finch Connect Session","href":"/implementation-guide/Connect/Set-Up-Finch-Connect"},{"title":"Retrieve Access Token","href":"/implementation-guide/Connect/Retrieve-Access-Token"}]},{"group":"Test","pages":[{"title":"Environments","href":"/implementation-guide/Test/Environments"},{"title":"Finch Sandbox","href":"/implementation-guide/Test/Finch-Sandbox"},{"title":"Provider Sandboxes","href":"/implementation-guide/Test/Provider-Sandboxes"}]},{"group":"Build Backend Application","pages":[{"title":"Backend Security","href":"/implementation-guide/Backend-Application/Backend-Security"},{"title":"Store Tokens","href":"/implementation-guide/Backend-Application/Store-Tokens"},{"title":"Disconnect Connections","href":"/implementation-guide/Backend-Application/Disconnect-Connections"},{"title":"Mitigate Errors","href":"/implementation-guide/Backend-Application/Mitigate-Errors"},{"title":"Monitor Usage","href":"/implementation-guide/Backend-Application/Monitor-Usage"},{"title":"Control Access (Optional)","href":"/implementation-guide/Backend-Application/Control-Access"},{"title":"Manage Connections","href":"/implementation-guide/Backend-Application/Manage-Connections"}]},{"group":"Make Finch API Calls","pages":[{"title":"Read Organization and Payroll Data","href":"/implementation-guide/API-Calls/Read-Data"},{"title":"Batch Requests","href":"/implementation-guide/API-Calls/Batch-Requests"},{"title":"Write Deductions","href":"/implementation-guide/API-Calls/Write-Data"}]},{"group":"Integration Preparation","pages":[{"title":"Email Forwarding","href":"/implementation-guide/Integration-Preparation/Email-Forwarding"},{"title":"Manage Integrations","href":"/implementation-guide/Integration-Preparation/Manage-Integrations"},{"title":"Configure Auth Methods","href":"/implementation-guide/Integration-Preparation/Configure-Auth-Methods"},{"title":"Security Reviews","href":"/implementation-guide/Integration-Preparation/Security-Reviews"}]},{"group":"Deploy and Manage","pages":[{"title":"Increase Employer Adoption","href":"/implementation-guide/Deploy-and-Manage/Increase-Employer-Adoption"},{"title":"Get support","href":"/implementation-guide/Deploy-and-Manage/Support"}]}]},{"group":"Developer Resources","pages":[{"title":"API Changes and Updates","href":"/developer-resources/api-changes"},{"title":"SDKs","href":"/developer-resources/SDKs"},{"title":"MCP","href":"/developer-resources/Finch-MCP-Server"},{"title":"Build or audit a Finch integration with AI agents","sidebarTitle":"Build or Audit with AI","href":"/developer-resources/Build-or-Audit-with-AI"},{"title":"Webhooks","href":"/developer-resources/Webhooks"},{"title":"Request Forwarding","href":"/developer-resources/Request-Forwarding"},{"title":"Data Access Controls","href":"/developer-resources/Data-Access-Controls"},{"title":"Data Syncs","href":"/developer-resources/Data-Syncs"},{"title":"Reauthentication","href":"/developer-resources/Reauthentication"},{"title":"Reconcile Employees","href":"/developer-resources/Reconcile-Employees"},{"title":"Enable Social Security Number (SSN) Field","href":"/developer-resources/Enable-SSN-Field"},{"title":"Calculate Year-To-Date (YTD) Wages","href":"/developer-resources/Calculating-YTD-Wages"},{"title":"W-2 Box 1","href":"/developer-resources/Calculating-W2-Box1-value"},{"title":"Pay Statement Type Classification","href":"/developer-resources/Pay-Statement-Type-Classification"},{"title":"Pay Statement Items \u0026 Rules","href":"/developer-resources/Pay-Statement-Items-Rules"},{"title":"Tiered Employer Matching","sidebarTitle":"Tiered Employer Matching","href":"/developer-resources/Tiered-Employer-Matching"},{"title":"Developer FAQs","href":"/developer-resources/Developer-FAQs"}]}]},{"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","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","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":"Request Forwarding - Finch","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}