Create a bank connection
curl --request POST \
--url https://app.sahlfinancial.com/api/v1/bank-connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"bank_code": "attijariwafa",
"bank_name": "Attijariwafa bank",
"case_id": "7e3b9a14-2d6c-4c85-b1f0-6a8d4e2c9b37"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
bank_code: 'attijariwafa',
bank_name: 'Attijariwafa bank',
case_id: '7e3b9a14-2d6c-4c85-b1f0-6a8d4e2c9b37'
})
};
fetch('https://app.sahlfinancial.com/api/v1/bank-connections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.sahlfinancial.com/api/v1/bank-connections"
payload = {
"bank_code": "attijariwafa",
"bank_name": "Attijariwafa bank",
"case_id": "7e3b9a14-2d6c-4c85-b1f0-6a8d4e2c9b37"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "c1a4e2d7-93b5-4f08-8a6d-2e7b1f9c3d54",
"tenant_id": "0b6f5a3e-7c1d-4e0a-9d2f-3a1c5e8b7f10",
"case_id": "7e3b9a14-2d6c-4c85-b1f0-6a8d4e2c9b37",
"bank_code": "attijariwafa",
"bank_name": "Attijariwafa bank",
"account_holder": "Test Client",
"account_last4": "4821",
"status": "connected",
"link_token": "Zk3x...redacted",
"connected_at": "2026-10-07T09:14:22Z",
"expires_at": "2027-01-05T09:14:22Z",
"avg_balance": 21450,
"monthly_income": 18200,
"monthly_expenses": 11800,
"transaction_count": 96,
"cash_flow_data": null,
"environment": "sandbox",
"created_at": "2026-10-07T09:14:22Z",
"updated_at": "2026-10-07T09:14:22Z"
}{
"detail": "Invalid or expired token"
}{
"detail": "Insufficient permissions"
}{
"detail": {
"code": "bank_connect_unavailable",
"message": "Bank connection is not available yet. No bank data provider is live for this workspace."
}
}{
"detail": [
{
"type": "missing",
"loc": [
"body",
"bank_code"
],
"msg": "Field required",
"input": {}
}
]
}{
"code": "rate_limit_exceeded",
"message": "Too many requests. Please slow down."
}Create a bank connection
Who can call it: tenant_admin, tenant_reviewer, tenant_api_manager or platform_admin. A tenant_viewer is read-only and gets 403.
Creates a simulated connection and marks it connected at once, with figures generated from its id. It is always filed as sandbox. case_id is stored only if the case belongs to your workspace; an unknown or foreign case id is silently ignored.
Production behaviour. No open-banking provider is live. This route answers 409 with the code bank_connect_unavailable unless the request is made in the Sandbox: send X-Sahl-Environment: sandbox (or ?environment=sandbox). In the Sandbox the data is simulated and derived from the connection id; it is not read from a bank. A request with no environment is also refused.
Auth: dashboard session (Authorization: Bearer <access token>). Not available with a partner API key.
Create a bank connection
curl --request POST \
--url https://app.sahlfinancial.com/api/v1/bank-connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"bank_code": "attijariwafa",
"bank_name": "Attijariwafa bank",
"case_id": "7e3b9a14-2d6c-4c85-b1f0-6a8d4e2c9b37"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
bank_code: 'attijariwafa',
bank_name: 'Attijariwafa bank',
case_id: '7e3b9a14-2d6c-4c85-b1f0-6a8d4e2c9b37'
})
};
fetch('https://app.sahlfinancial.com/api/v1/bank-connections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.sahlfinancial.com/api/v1/bank-connections"
payload = {
"bank_code": "attijariwafa",
"bank_name": "Attijariwafa bank",
"case_id": "7e3b9a14-2d6c-4c85-b1f0-6a8d4e2c9b37"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "c1a4e2d7-93b5-4f08-8a6d-2e7b1f9c3d54",
"tenant_id": "0b6f5a3e-7c1d-4e0a-9d2f-3a1c5e8b7f10",
"case_id": "7e3b9a14-2d6c-4c85-b1f0-6a8d4e2c9b37",
"bank_code": "attijariwafa",
"bank_name": "Attijariwafa bank",
"account_holder": "Test Client",
"account_last4": "4821",
"status": "connected",
"link_token": "Zk3x...redacted",
"connected_at": "2026-10-07T09:14:22Z",
"expires_at": "2027-01-05T09:14:22Z",
"avg_balance": 21450,
"monthly_income": 18200,
"monthly_expenses": 11800,
"transaction_count": 96,
"cash_flow_data": null,
"environment": "sandbox",
"created_at": "2026-10-07T09:14:22Z",
"updated_at": "2026-10-07T09:14:22Z"
}{
"detail": "Invalid or expired token"
}{
"detail": "Insufficient permissions"
}{
"detail": {
"code": "bank_connect_unavailable",
"message": "Bank connection is not available yet. No bank data provider is live for this workspace."
}
}{
"detail": [
{
"type": "missing",
"loc": [
"body",
"bank_code"
],
"msg": "Field required",
"input": {}
}
]
}{
"code": "rate_limit_exceeded",
"message": "Too many requests. Please slow down."
}Authorizations
The access token (JWT) of a signed-in console user, from POST /v1/auth/login. It lasts 30 minutes. It is not an API key: a partner API key is refused here. There is no cookie.
Headers
Query Parameters
Body
application/json
Response
Created