Create a connection

Generic, provider-discriminated create. Supersedes POST /connections/plaid/exchange, POST /connections/teller, and POST /connections/csv/import.

The credentials shape depends on provider:

• plaid — {public_token, institution_id, institution_name, accounts?}
• teller — {access_token, enrollment_id, institution_id?, institution_name, accounts?}
• csv — {csv_base64, column_mapping, account_name?, date_format?, ...} (also accepts multipart/form-data with a file field plus the same configuration fields as form values).

Returns the same {connection_id, institution_name, status} envelope all three legacy routes produce. Requires full_access scope.

Create a connection

cURL

curl --request POST \
  --url https://breadbox.example.com/api/v1/connections \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "user_id": "<string>",
  "credentials": {}
}
'

import requests

url = "https://breadbox.example.com/api/v1/connections"

payload = {
    "user_id": "<string>",
    "credentials": {}
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({user_id: '<string>', credentials: {}})
};

fetch('https://breadbox.example.com/api/v1/connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://breadbox.example.com/api/v1/connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_id' => '<string>',
    'credentials' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://breadbox.example.com/api/v1/connections"

	payload := strings.NewReader("{\n  \"user_id\": \"<string>\",\n  \"credentials\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://breadbox.example.com/api/v1/connections")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"<string>\",\n  \"credentials\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://breadbox.example.com/api/v1/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"<string>\",\n  \"credentials\": {}\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": "<string>",
  "short_id": "<string>",
  "user_id": "<string>",
  "institution_name": "<string>",
  "institution_id": "<string>",
  "paused": true,
  "sync_interval_seconds": 123,
  "last_sync_at": "2023-11-07T05:31:56Z",
  "next_sync_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

X-API-Key · string · header · required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Body

application/jsonmultipart/form-data

provider · enum<string> · required

Available options: plaid, teller, csv

user_id · string

UUID or short_id

credentials · object

Response

201

application/json

Created connection.

id · string

short_id · string

user_id · string

provider · enum<string>

Available options: plaid, teller, csv

institution_name · string | null

institution_id · string | null

status · enum<string>

Available options: active, error, pending_reauth, disconnected

paused · boolean

sync_interval_seconds · integer | null

last_sync_at · string<date-time> | null

next_sync_at · string<date-time> | null

created_at · string<date-time>

updated_at · string<date-time>