Add an external account
curl --request POST \
--url https://api.synctera.com/v2/external_accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_identifiers": {
"iban": "LI4476584648937N59B00",
"number": "78277121"
},
"account_owner_names": [
"Jane Smith"
],
"routing_identifiers": {
"bank_countries": [
"US"
],
"bank_name": "Chase",
"ach_routing_number": "756392185",
"eft_ca_routing_number": "02101140",
"wire_routing_number": "915075033"
},
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"currency": "USD",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"metadata": {},
"nickname": "Vacation savings",
"tenant": "abcdef_ghijkl",
"vendor_account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
"verification": {
"creation_time": "2010-05-06T12:23:34.321Z",
"last_updated_time": "2010-05-06T12:23:34.321Z"
}
}
'import requests
url = "https://api.synctera.com/v2/external_accounts"
payload = {
"account_identifiers": {
"iban": "LI4476584648937N59B00",
"number": "78277121"
},
"account_owner_names": ["Jane Smith"],
"routing_identifiers": {
"bank_countries": ["US"],
"bank_name": "Chase",
"ach_routing_number": "756392185",
"eft_ca_routing_number": "02101140",
"wire_routing_number": "915075033"
},
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"currency": "USD",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"metadata": {},
"nickname": "Vacation savings",
"tenant": "abcdef_ghijkl",
"vendor_account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
"verification": {
"creation_time": "2010-05-06T12:23:34.321Z",
"last_updated_time": "2010-05-06T12:23:34.321Z"
}
}
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({
account_identifiers: {iban: 'LI4476584648937N59B00', number: '78277121'},
account_owner_names: ['Jane Smith'],
routing_identifiers: {
bank_countries: ['US'],
bank_name: 'Chase',
ach_routing_number: '756392185',
eft_ca_routing_number: '02101140',
wire_routing_number: '915075033'
},
business_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
currency: 'USD',
customer_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
metadata: {},
nickname: 'Vacation savings',
tenant: 'abcdef_ghijkl',
vendor_account_id: 'blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo',
verification: {
creation_time: '2010-05-06T12:23:34.321Z',
last_updated_time: '2010-05-06T12:23:34.321Z'
}
})
};
fetch('https://api.synctera.com/v2/external_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.synctera.com/v2/external_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([
'account_identifiers' => [
'iban' => 'LI4476584648937N59B00',
'number' => '78277121'
],
'account_owner_names' => [
'Jane Smith'
],
'routing_identifiers' => [
'bank_countries' => [
'US'
],
'bank_name' => 'Chase',
'ach_routing_number' => '756392185',
'eft_ca_routing_number' => '02101140',
'wire_routing_number' => '915075033'
],
'business_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'currency' => 'USD',
'customer_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'metadata' => [
],
'nickname' => 'Vacation savings',
'tenant' => 'abcdef_ghijkl',
'vendor_account_id' => 'blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo',
'verification' => [
'creation_time' => '2010-05-06T12:23:34.321Z',
'last_updated_time' => '2010-05-06T12:23:34.321Z'
]
]),
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.synctera.com/v2/external_accounts"
payload := strings.NewReader("{\n \"account_identifiers\": {\n \"iban\": \"LI4476584648937N59B00\",\n \"number\": \"78277121\"\n },\n \"account_owner_names\": [\n \"Jane Smith\"\n ],\n \"routing_identifiers\": {\n \"bank_countries\": [\n \"US\"\n ],\n \"bank_name\": \"Chase\",\n \"ach_routing_number\": \"756392185\",\n \"eft_ca_routing_number\": \"02101140\",\n \"wire_routing_number\": \"915075033\"\n },\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"currency\": \"USD\",\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"metadata\": {},\n \"nickname\": \"Vacation savings\",\n \"tenant\": \"abcdef_ghijkl\",\n \"vendor_account_id\": \"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo\",\n \"verification\": {\n \"creation_time\": \"2010-05-06T12:23:34.321Z\",\n \"last_updated_time\": \"2010-05-06T12:23:34.321Z\"\n }\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.synctera.com/v2/external_accounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_identifiers\": {\n \"iban\": \"LI4476584648937N59B00\",\n \"number\": \"78277121\"\n },\n \"account_owner_names\": [\n \"Jane Smith\"\n ],\n \"routing_identifiers\": {\n \"bank_countries\": [\n \"US\"\n ],\n \"bank_name\": \"Chase\",\n \"ach_routing_number\": \"756392185\",\n \"eft_ca_routing_number\": \"02101140\",\n \"wire_routing_number\": \"915075033\"\n },\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"currency\": \"USD\",\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"metadata\": {},\n \"nickname\": \"Vacation savings\",\n \"tenant\": \"abcdef_ghijkl\",\n \"vendor_account_id\": \"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo\",\n \"verification\": {\n \"creation_time\": \"2010-05-06T12:23:34.321Z\",\n \"last_updated_time\": \"2010-05-06T12:23:34.321Z\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v2/external_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 \"account_identifiers\": {\n \"iban\": \"LI4476584648937N59B00\",\n \"number\": \"78277121\"\n },\n \"account_owner_names\": [\n \"Jane Smith\"\n ],\n \"routing_identifiers\": {\n \"bank_countries\": [\n \"US\"\n ],\n \"bank_name\": \"Chase\",\n \"ach_routing_number\": \"756392185\",\n \"eft_ca_routing_number\": \"02101140\",\n \"wire_routing_number\": \"915075033\"\n },\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"currency\": \"USD\",\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"metadata\": {},\n \"nickname\": \"Vacation savings\",\n \"tenant\": \"abcdef_ghijkl\",\n \"vendor_account_id\": \"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo\",\n \"verification\": {\n \"creation_time\": \"2010-05-06T12:23:34.321Z\",\n \"last_updated_time\": \"2010-05-06T12:23:34.321Z\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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",
"network": "ALGORAND",
"swift_code": "CHASUS3AXXX",
"wire_routing_number": "756392185"
},
"status": "ACTIVE",
"type": "CHECKING",
"verification": {
"status": "UNVERIFIED",
"vendor": "FINICITY",
"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"
}{
"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 an external account
Add an external account for a customer. The account will be created in an unverified state.
POST
/
external_accounts
Add an external account
curl --request POST \
--url https://api.synctera.com/v2/external_accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_identifiers": {
"iban": "LI4476584648937N59B00",
"number": "78277121"
},
"account_owner_names": [
"Jane Smith"
],
"routing_identifiers": {
"bank_countries": [
"US"
],
"bank_name": "Chase",
"ach_routing_number": "756392185",
"eft_ca_routing_number": "02101140",
"wire_routing_number": "915075033"
},
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"currency": "USD",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"metadata": {},
"nickname": "Vacation savings",
"tenant": "abcdef_ghijkl",
"vendor_account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
"verification": {
"creation_time": "2010-05-06T12:23:34.321Z",
"last_updated_time": "2010-05-06T12:23:34.321Z"
}
}
'import requests
url = "https://api.synctera.com/v2/external_accounts"
payload = {
"account_identifiers": {
"iban": "LI4476584648937N59B00",
"number": "78277121"
},
"account_owner_names": ["Jane Smith"],
"routing_identifiers": {
"bank_countries": ["US"],
"bank_name": "Chase",
"ach_routing_number": "756392185",
"eft_ca_routing_number": "02101140",
"wire_routing_number": "915075033"
},
"business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"currency": "USD",
"customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"metadata": {},
"nickname": "Vacation savings",
"tenant": "abcdef_ghijkl",
"vendor_account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
"verification": {
"creation_time": "2010-05-06T12:23:34.321Z",
"last_updated_time": "2010-05-06T12:23:34.321Z"
}
}
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({
account_identifiers: {iban: 'LI4476584648937N59B00', number: '78277121'},
account_owner_names: ['Jane Smith'],
routing_identifiers: {
bank_countries: ['US'],
bank_name: 'Chase',
ach_routing_number: '756392185',
eft_ca_routing_number: '02101140',
wire_routing_number: '915075033'
},
business_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
currency: 'USD',
customer_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
metadata: {},
nickname: 'Vacation savings',
tenant: 'abcdef_ghijkl',
vendor_account_id: 'blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo',
verification: {
creation_time: '2010-05-06T12:23:34.321Z',
last_updated_time: '2010-05-06T12:23:34.321Z'
}
})
};
fetch('https://api.synctera.com/v2/external_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.synctera.com/v2/external_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([
'account_identifiers' => [
'iban' => 'LI4476584648937N59B00',
'number' => '78277121'
],
'account_owner_names' => [
'Jane Smith'
],
'routing_identifiers' => [
'bank_countries' => [
'US'
],
'bank_name' => 'Chase',
'ach_routing_number' => '756392185',
'eft_ca_routing_number' => '02101140',
'wire_routing_number' => '915075033'
],
'business_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'currency' => 'USD',
'customer_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'metadata' => [
],
'nickname' => 'Vacation savings',
'tenant' => 'abcdef_ghijkl',
'vendor_account_id' => 'blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo',
'verification' => [
'creation_time' => '2010-05-06T12:23:34.321Z',
'last_updated_time' => '2010-05-06T12:23:34.321Z'
]
]),
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.synctera.com/v2/external_accounts"
payload := strings.NewReader("{\n \"account_identifiers\": {\n \"iban\": \"LI4476584648937N59B00\",\n \"number\": \"78277121\"\n },\n \"account_owner_names\": [\n \"Jane Smith\"\n ],\n \"routing_identifiers\": {\n \"bank_countries\": [\n \"US\"\n ],\n \"bank_name\": \"Chase\",\n \"ach_routing_number\": \"756392185\",\n \"eft_ca_routing_number\": \"02101140\",\n \"wire_routing_number\": \"915075033\"\n },\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"currency\": \"USD\",\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"metadata\": {},\n \"nickname\": \"Vacation savings\",\n \"tenant\": \"abcdef_ghijkl\",\n \"vendor_account_id\": \"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo\",\n \"verification\": {\n \"creation_time\": \"2010-05-06T12:23:34.321Z\",\n \"last_updated_time\": \"2010-05-06T12:23:34.321Z\"\n }\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.synctera.com/v2/external_accounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_identifiers\": {\n \"iban\": \"LI4476584648937N59B00\",\n \"number\": \"78277121\"\n },\n \"account_owner_names\": [\n \"Jane Smith\"\n ],\n \"routing_identifiers\": {\n \"bank_countries\": [\n \"US\"\n ],\n \"bank_name\": \"Chase\",\n \"ach_routing_number\": \"756392185\",\n \"eft_ca_routing_number\": \"02101140\",\n \"wire_routing_number\": \"915075033\"\n },\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"currency\": \"USD\",\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"metadata\": {},\n \"nickname\": \"Vacation savings\",\n \"tenant\": \"abcdef_ghijkl\",\n \"vendor_account_id\": \"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo\",\n \"verification\": {\n \"creation_time\": \"2010-05-06T12:23:34.321Z\",\n \"last_updated_time\": \"2010-05-06T12:23:34.321Z\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.synctera.com/v2/external_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 \"account_identifiers\": {\n \"iban\": \"LI4476584648937N59B00\",\n \"number\": \"78277121\"\n },\n \"account_owner_names\": [\n \"Jane Smith\"\n ],\n \"routing_identifiers\": {\n \"bank_countries\": [\n \"US\"\n ],\n \"bank_name\": \"Chase\",\n \"ach_routing_number\": \"756392185\",\n \"eft_ca_routing_number\": \"02101140\",\n \"wire_routing_number\": \"915075033\"\n },\n \"business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"currency\": \"USD\",\n \"customer_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"metadata\": {},\n \"nickname\": \"Vacation savings\",\n \"tenant\": \"abcdef_ghijkl\",\n \"vendor_account_id\": \"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo\",\n \"verification\": {\n \"creation_time\": \"2010-05-06T12:23:34.321Z\",\n \"last_updated_time\": \"2010-05-06T12:23:34.321Z\"\n }\n}"
response = http.request(request)
puts response.read_body{
"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",
"network": "ALGORAND",
"swift_code": "CHASUS3AXXX",
"wire_routing_number": "756392185"
},
"status": "ACTIVE",
"type": "CHECKING",
"verification": {
"status": "UNVERIFIED",
"vendor": "FINICITY",
"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"
}{
"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 identifiers for the account. At least one of number or iban must be specified. Account number or IBAN can be specified for international accounts. For domestic accounts, only account number is required.
Show child attributes
Show child attributes
The names of the account owners.
Minimum array length:
1Minimum string length:
1The 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 Show child attributes
Show child attributes
The type of the account
Available options:
CHECKING, CRYPTO_WALLET, OTHER_BANK_ACCOUNT, SAVINGS, WALLET 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"
ISO 4217 alphabetic currency code
Pattern:
^[A-Z]{3}$Example:
"USD"
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"
User-supplied metadata
A user-meaningful name for the account
Minimum string length:
1Example:
"Vacation savings"
The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
Example:
"abcdef_ghijkl"
The ID of the vendor account, will be empty for MANUAL vendor
Minimum string length:
1Example:
"blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo"
Information about the account verification process. If the account has not been verified, this will be null.
- Information specific to Plaid verification
- Information specific to Finicity verification
- Information specific to Manual verification
Show child attributes
Show child attributes
Response
The external account added.
Show child attributes
Show child attributes
The names of the account owners. Values may be masked, in which case the array will be empty.
Example:
"2010-05-06T12:23:34.321Z"
External account unique identifier
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Example:
"2010-05-06T12:23:34.321Z"
Show child attributes
Show child attributes
The current state of the account
Available options:
ACTIVE, CLOSED, DELETED, INACTIVE The type of the account
Available options:
CHECKING, CREDIT_CARD, CRYPTO_WALLET, INVESTMENT_529, MONEY_MARKET, OTHER, OTHER_BANK_ACCOUNT, SAVINGS, WALLET Information about the account verification process. If the account has not been verified, this will be null.
- Information specific to Plaid verification
- Information specific to Finicity verification
- Information specific to Manual verification
Show child attributes
Show child attributes
The identifier for the business customer associated with this external account. Exactly one of business_id or customer_id will be returned.
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
ISO 4217 alphabetic currency code
Pattern:
^[A-Z]{3}$Example:
"USD"
The identifier for the personal customer associated with this external account. Exactly one of customer_id or business_id will be returned.
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Example:
"2010-05-06T12:23:34.321Z"
User-supplied JSON format metadata.
The official name of the account
Example:
"Plaid Checking"
A user-meaningful name for the account
Example:
"Vacation savings"
The reason for the status for the external account.
The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
Example:
"abcdef_ghijkl"
Show child attributes
Show child attributes
The information provided to Synctera from the vendor. Interpretation of this object is up to the client.
- Vendor Info
- Vendor Info
Show child attributes
Show child attributes
Was this page helpful?