Add external accounts through a vendor, such as Plaid.
curl --request POST \
--url https://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"vendor_access_token": "access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6",
"vendor_account_ids": [
"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo"
],
"vendor_customer_id": 123,
"verify_owner": false
}
'import requests
url = "https://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts"
payload = {
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"vendor_access_token": "access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6",
"vendor_account_ids": ["blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo"],
"vendor_customer_id": 123,
"verify_owner": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
business_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
customer_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
vendor_access_token: 'access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6',
vendor_account_ids: ['blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo'],
vendor_customer_id: 123,
verify_owner: false
})
};
fetch('https://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts', 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://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts",
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([
'business_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'customer_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'vendor_access_token' => 'access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6',
'vendor_account_ids' => [
'blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo'
],
'vendor_customer_id' => 123,
'verify_owner' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts"
payload := strings.NewReader("{\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"vendor_access_token\": \"access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6\",\n \"vendor_account_ids\": [\n \"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo\"\n ],\n \"vendor_customer_id\": 123,\n \"verify_owner\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"vendor_access_token\": \"access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6\",\n \"vendor_account_ids\": [\n \"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo\"\n ],\n \"vendor_customer_id\": 123,\n \"verify_owner\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"vendor_access_token\": \"access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6\",\n \"vendor_account_ids\": [\n \"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo\"\n ],\n \"vendor_customer_id\": 123,\n \"verify_owner\": false\n}"
response = http.request(request)
puts response.read_body{
"added_accounts": [
{
"account_identifiers": {
"number": "78277121",
"iban": "LI4476584648937N59B00"
},
"account_owner_names": [
"Jane Smith"
],
"creation_time": "2010-05-06T12:23:34.321Z",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"last_updated_time": "2010-05-06T12:23:34.321Z",
"routing_identifiers": {
"bank_countries": [
"US"
],
"bank_name": "Chase",
"ach_routing_number": "756392185",
"bank_address": {
"address_line_1": "100 Main St.",
"country_code": "US",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"correspondent_bank_details": [
{
"bank_address": {
"address_line_1": "100 Main St.",
"country_code": "US",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"bank_name": "Bank of Greece",
"swift_code": "BNGRGRAAXXX"
}
],
"eft_ca_routing_number": "02101140",
"eft_routing_number": "02101140",
"swift_code": "CHASUS3AXXX",
"wire_routing_number": "756392185"
},
"verification": {
"creation_time": "2010-05-06T12:23:34.321Z",
"last_updated_time": "2010-05-06T12:23:34.321Z"
},
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"currency": "USD",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"deletion_time": "2010-05-06T12:23:34.321Z",
"metadata": {},
"name": "Plaid Checking",
"nickname": "Vacation savings",
"status_reason": "<string>",
"tenant": "abcdef_ghijkl",
"vendor_data": {
"account_number_mask": "<string>",
"institution_id": "<string>"
},
"vendor_info": {
"content_type": "application/json",
"json": {},
"vendor": "SOCURE"
}
}
],
"failed_accounts": [
{
"reason_description": "<string>",
"vendor_account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
"vendor_error_message": "<string>",
"vendor_request_id": "<string>"
}
],
"deleted_accounts": [
{
"account_identifiers": {
"number": "78277121",
"iban": "LI4476584648937N59B00"
},
"account_owner_names": [
"Jane Smith"
],
"creation_time": "2010-05-06T12:23:34.321Z",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"last_updated_time": "2010-05-06T12:23:34.321Z",
"routing_identifiers": {
"bank_countries": [
"US"
],
"bank_name": "Chase",
"ach_routing_number": "756392185",
"bank_address": {
"address_line_1": "100 Main St.",
"country_code": "US",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"correspondent_bank_details": [
{
"bank_address": {
"address_line_1": "100 Main St.",
"country_code": "US",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"bank_name": "Bank of Greece",
"swift_code": "BNGRGRAAXXX"
}
],
"eft_ca_routing_number": "02101140",
"eft_routing_number": "02101140",
"swift_code": "CHASUS3AXXX",
"wire_routing_number": "756392185"
},
"verification": {
"creation_time": "2010-05-06T12:23:34.321Z",
"last_updated_time": "2010-05-06T12:23:34.321Z"
},
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"currency": "USD",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"deletion_time": "2010-05-06T12:23:34.321Z",
"metadata": {},
"name": "Plaid Checking",
"nickname": "Vacation savings",
"status_reason": "<string>",
"tenant": "abcdef_ghijkl",
"vendor_data": {
"account_number_mask": "<string>",
"institution_id": "<string>"
},
"vendor_info": {
"content_type": "application/json",
"json": {},
"vendor": "SOCURE"
}
}
]
}{
"code": "BAD_REQUEST_BODY",
"detail": "missing required fields: first_name, dob",
"status": 400,
"title": "Bad Request Body",
"type": "https://dev.synctera.com/errors/bad-request-body"
}{
"code": "BAD_REQUEST_BODY",
"detail": "missing required fields: first_name, dob",
"status": 400,
"title": "Bad Request Body",
"type": "https://dev.synctera.com/errors/bad-request-body"
}{
"code": "BAD_REQUEST_BODY",
"detail": "missing required fields: first_name, dob",
"status": 400,
"title": "Bad Request Body",
"type": "https://dev.synctera.com/errors/bad-request-body"
}{
"code": "BAD_REQUEST_BODY",
"detail": "missing required fields: first_name, dob",
"status": 400,
"title": "Bad Request Body",
"type": "https://dev.synctera.com/errors/bad-request-body"
}External Accounts
Add external accounts through a vendor, such as Plaid.
Add external accounts for a customer through an existing access token. The token must be valid, and the information on the accounts returned by the vendor must correspond to the customer. A success response for this route may include failures if an account could not be added, so it’s important that the caller checks the response body.
POST
/
external_accounts
/
add_vendor_accounts
Add external accounts through a vendor, such as Plaid.
curl --request POST \
--url https://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"vendor_access_token": "access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6",
"vendor_account_ids": [
"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo"
],
"vendor_customer_id": 123,
"verify_owner": false
}
'import requests
url = "https://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts"
payload = {
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"vendor_access_token": "access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6",
"vendor_account_ids": ["blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo"],
"vendor_customer_id": 123,
"verify_owner": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
business_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
customer_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
vendor_access_token: 'access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6',
vendor_account_ids: ['blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo'],
vendor_customer_id: 123,
verify_owner: false
})
};
fetch('https://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts', 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://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts",
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([
'business_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'customer_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'vendor_access_token' => 'access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6',
'vendor_account_ids' => [
'blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo'
],
'vendor_customer_id' => 123,
'verify_owner' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts"
payload := strings.NewReader("{\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"vendor_access_token\": \"access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6\",\n \"vendor_account_ids\": [\n \"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo\"\n ],\n \"vendor_customer_id\": 123,\n \"verify_owner\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"vendor_access_token\": \"access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6\",\n \"vendor_account_ids\": [\n \"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo\"\n ],\n \"vendor_customer_id\": 123,\n \"verify_owner\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/external_accounts/add_vendor_accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"vendor_access_token\": \"access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6\",\n \"vendor_account_ids\": [\n \"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo\"\n ],\n \"vendor_customer_id\": 123,\n \"verify_owner\": false\n}"
response = http.request(request)
puts response.read_body{
"added_accounts": [
{
"account_identifiers": {
"number": "78277121",
"iban": "LI4476584648937N59B00"
},
"account_owner_names": [
"Jane Smith"
],
"creation_time": "2010-05-06T12:23:34.321Z",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"last_updated_time": "2010-05-06T12:23:34.321Z",
"routing_identifiers": {
"bank_countries": [
"US"
],
"bank_name": "Chase",
"ach_routing_number": "756392185",
"bank_address": {
"address_line_1": "100 Main St.",
"country_code": "US",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"correspondent_bank_details": [
{
"bank_address": {
"address_line_1": "100 Main St.",
"country_code": "US",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"bank_name": "Bank of Greece",
"swift_code": "BNGRGRAAXXX"
}
],
"eft_ca_routing_number": "02101140",
"eft_routing_number": "02101140",
"swift_code": "CHASUS3AXXX",
"wire_routing_number": "756392185"
},
"verification": {
"creation_time": "2010-05-06T12:23:34.321Z",
"last_updated_time": "2010-05-06T12:23:34.321Z"
},
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"currency": "USD",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"deletion_time": "2010-05-06T12:23:34.321Z",
"metadata": {},
"name": "Plaid Checking",
"nickname": "Vacation savings",
"status_reason": "<string>",
"tenant": "abcdef_ghijkl",
"vendor_data": {
"account_number_mask": "<string>",
"institution_id": "<string>"
},
"vendor_info": {
"content_type": "application/json",
"json": {},
"vendor": "SOCURE"
}
}
],
"failed_accounts": [
{
"reason_description": "<string>",
"vendor_account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
"vendor_error_message": "<string>",
"vendor_request_id": "<string>"
}
],
"deleted_accounts": [
{
"account_identifiers": {
"number": "78277121",
"iban": "LI4476584648937N59B00"
},
"account_owner_names": [
"Jane Smith"
],
"creation_time": "2010-05-06T12:23:34.321Z",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"last_updated_time": "2010-05-06T12:23:34.321Z",
"routing_identifiers": {
"bank_countries": [
"US"
],
"bank_name": "Chase",
"ach_routing_number": "756392185",
"bank_address": {
"address_line_1": "100 Main St.",
"country_code": "US",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"correspondent_bank_details": [
{
"bank_address": {
"address_line_1": "100 Main St.",
"country_code": "US",
"address_line_2": "Suite 99",
"address_type": "SHIPPING",
"city": "New York",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_registered_agent": true,
"nickname": "Home",
"postal_code": "28620",
"state": "NY"
},
"bank_name": "Bank of Greece",
"swift_code": "BNGRGRAAXXX"
}
],
"eft_ca_routing_number": "02101140",
"eft_routing_number": "02101140",
"swift_code": "CHASUS3AXXX",
"wire_routing_number": "756392185"
},
"verification": {
"creation_time": "2010-05-06T12:23:34.321Z",
"last_updated_time": "2010-05-06T12:23:34.321Z"
},
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"currency": "USD",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"deletion_time": "2010-05-06T12:23:34.321Z",
"metadata": {},
"name": "Plaid Checking",
"nickname": "Vacation savings",
"status_reason": "<string>",
"tenant": "abcdef_ghijkl",
"vendor_data": {
"account_number_mask": "<string>",
"institution_id": "<string>"
},
"vendor_info": {
"content_type": "application/json",
"json": {},
"vendor": "SOCURE"
}
}
]
}{
"code": "BAD_REQUEST_BODY",
"detail": "missing required fields: first_name, dob",
"status": 400,
"title": "Bad Request Body",
"type": "https://dev.synctera.com/errors/bad-request-body"
}{
"code": "BAD_REQUEST_BODY",
"detail": "missing required fields: first_name, dob",
"status": 400,
"title": "Bad Request Body",
"type": "https://dev.synctera.com/errors/bad-request-body"
}{
"code": "BAD_REQUEST_BODY",
"detail": "missing required fields: first_name, dob",
"status": 400,
"title": "Bad Request Body",
"type": "https://dev.synctera.com/errors/bad-request-body"
}{
"code": "BAD_REQUEST_BODY",
"detail": "missing required fields: first_name, dob",
"status": 400,
"title": "Bad Request Body",
"type": "https://dev.synctera.com/errors/bad-request-body"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Body
application/json
The type of customer in the external financial institution. Not necessarily the customer type on Synctera's platform: a business customer might link to the owner's personal account at an external financial institution.
Available options:
BUSINESS, PERSONAL The vendor selected for the operation.
Available options:
FINICITY, PLAID The identifier for the business customer associated with this external account. Exactly one of business_id or customer_id must be specified.
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
The identifier for the personal customer associated with this external account. Exactly one of customer_id or business_id must be specified.
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
The token provided to link external accounts. For Plaid, this is their access_token.
Minimum string length:
1Example:
"access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6"
The list of vendor account IDs that the customer chose to link. For Plaid, these are account_ids.
Minimum array length:
1The Plaid account_id.
Minimum string length:
1The identifier provided by the vendor for the customer associated with this external account.
Example:
123
If true, Synctera will attempt to verify that the external account owner is the same as the customer by comparing external account data to customer data. At least 2 of the following fields must match: name, phone number, email, address. Verification is disabled by default.
Was this page helpful?
Create a permanent access token for an external accountCreate a link token to verify an external account
⌘I