Create a session
Create a connection session and return a link URL that launches the frontend experience.
Use the returned link based on the verification type:
- Payroll
- Embedded Link (recommended) — pass it as
connectUrlwhen initializing Link, including iframe implementations where callbacks are needed. - Hosted Link — on web, open it in the same tab, a popup window, or a separate tab. On mobile, if you do not want to use Argyle native SDKs, open it in a secure browser context such as
ASWebAuthenticationSessionor Android Custom Tabs.
- Embedded Link (recommended) — pass it as
- Banking
- Embedded banking session (recommended) — on web, load it in an iframe. On mobile, open it inside your app’s banking frontend container such as a webview or secure browser container.
- Hosted banking session — on web, open it in the same tab, a popup window, or a separate tab. On mobile, open it in a secure browser context such as
ASWebAuthenticationSessionor Android Custom Tabs.
For Hosted/direct-launch flows, always set configuration.redirect_url so the user returns to your application.
Authorizations
Username = api_key_id, Password = api_key_secret
Body
Response
Partner connection session object.
Verification ID associated with the session.
Connection session configuration for payroll and banking verifications.
URL used to launch the payroll or banking frontend experience. For payroll, use it as connectUrl when initializing Embedded Link; the returned session URL already determines whether the session runs in Sandbox or Production. Alternatively, open it directly for Hosted Link. For banking, use it to launch either an Embedded banking session or a Hosted banking session.
Source of connection data.
payroll, banking