curl --request GET \
--url https://api.synci.io/managed/v1/connections \
--header 'Authorization: Basic <encoded-value>'const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.synci.io/managed/v1/connections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.synci.io/managed/v1/connections"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.synci.io/managed/v1/connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.synci.io/managed/v1/connections"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"id": "<string>",
"user_id": "<string>",
"external_user_id": "<string>",
"status": "<string>",
"status_message": "<string>",
"enabled": true,
"institution": {
"id": "<string>",
"name": "<string>",
"logo": "<string>",
"country": "<string>",
"provider": "<string>"
},
"health": {
"status": "<string>",
"failure_count": "<string>",
"integrator_message": "<string>",
"last_attempt_at": "<string>"
},
"consent_expires_at": "<string>",
"access_valid_for_days": "<string>",
"accounts_last_synced_at": "<string>",
"created_at": "<string>",
"accounts_count": 123
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 2,
"from": 2,
"last_page": 2,
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
],
"path": "<string>",
"per_page": 1,
"to": 2,
"total": 1
}
}{
"message": "<string>",
"errors": {}
}List your users' financial connections
Every connection your users hold, newest first: bank, brokerage and
crypto-exchange alike. Filter by user, status, provider, or
expiring_within_days for the re-consent sweep.
curl --request GET \
--url https://api.synci.io/managed/v1/connections \
--header 'Authorization: Basic <encoded-value>'const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.synci.io/managed/v1/connections', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.synci.io/managed/v1/connections"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.synci.io/managed/v1/connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.synci.io/managed/v1/connections"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": [
{
"id": "<string>",
"user_id": "<string>",
"external_user_id": "<string>",
"status": "<string>",
"status_message": "<string>",
"enabled": true,
"institution": {
"id": "<string>",
"name": "<string>",
"logo": "<string>",
"country": "<string>",
"provider": "<string>"
},
"health": {
"status": "<string>",
"failure_count": "<string>",
"integrator_message": "<string>",
"last_attempt_at": "<string>"
},
"consent_expires_at": "<string>",
"access_valid_for_days": "<string>",
"accounts_last_synced_at": "<string>",
"created_at": "<string>",
"accounts_count": 123
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 2,
"from": 2,
"last_page": 2,
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
],
"path": "<string>",
"per_page": 1,
"to": 2,
"total": 1
}
}{
"message": "<string>",
"errors": {}
}Authorizations
Username = your client id. Password = your client secret.
So the base64-encoded username:password described below is
client_id:client_secret:
Authorization: Basic base64(YOUR_CLIENT_ID:YOUR_CLIENT_SECRET)
Most HTTP clients build that header for you:
curl -u "YOUR_CLIENT_ID:YOUR_CLIENT_SECRET" \ https://api.synci.io/managed/v1/users
Both values come from Developers → Apps → your app. The
secret is shown once at creation and is prefixed oac_.
Query Parameters
One of your users, by the id this API gave you.
64One of your users, by your own correlation id.
255The lifecycle status of a financial connection, the same for every provider.
PENDING_AUTHORIZATION, CONNECTED, DISABLED, REVOKED, EXPIRED, ERROR The provider a financial connection or account is sourced from: GOCARDLESS (EU/UK banks), AKAHU (NZ banks), ARRAY (US banks), SNAPTRADE (brokerages and crypto exchanges) or DEMO (Synci's demo banks). UNKNOWN is used for accounts created manually via the API.
UNKNOWN |
GOCARDLESS |
AKAHU |
ARRAY US banks. One connection can carry depository, liability and investment accounts, and transactions arrive already enriched. Connections cannot be created through the API: the consent flow is an embedded SDK, so they are started from the Synci Dashboard or the connection portal. |
SNAPTRADE |
DEMO Synci's demo banks. Accounts, balances and transactions are generated by Synci rather than fetched from a bank, and otherwise behave like real data: syncs, webhooks and transfer links all run. |
UNKNOWN, GOCARDLESS, AKAHU, ARRAY, SNAPTRADE, DEMO Connections whose bank consent lapses within N days — the re-consent sweep. GoCardless only; other providers never expire.
0 <= x <= 3651 <= x <= 200x >= 1