[
/docs
·
Connect
]
Create a connect session
Everything POST /v3/connect/sessions accepts, and what comes back.
group
Connect
A connect session describes one linking attempt: which scopes you need, which countries to show, and where to send the user afterwards. Create it on your server, never in the browser, because it uses your secret key.
The scopes array sets the scopes the user will see on the consent screen. Keep it short; every extra scope is one more line the user has to accept.
Set institution_id to skip the bank picker when you already know the bank, for example during a re-auth. Set redirect_uri when Connect opens in a mobile browser and needs to return to your app.
The session returns status pending, completed or abandoned. Abandoned sessions are a useful signal: they tell you which step users stop at.
[ example request ]
Node
Python
cURL
connect
import { Sluice } from ‘@sluice/node’;
const sluice = new Sluice(process.env.SLUICE_KEY);
const session = await sluice.connect.sessions.create({
user: ‘user_31c’,
scopes: [‘balances’, ‘transactions’],
});
// send session.url to your user
201 Created · 84 ms
id cs_7Hq2
url https://connect.sluice.dev/cs_7Hq2
expires_in 900
[
→
·
more guides
]
Next on the list.
Sluice® Template
$129 · one-time
NOVA STUDIO
/ SECURED BY POLAR