Create account relationship
curl --request POST \
--url https://api-sandbox.synctera.com/v0/accounts/{account_id}/relationships \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deleted_at": "2023-11-07T05:31:56Z",
"ownership_percentage": 35.75,
"person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api-sandbox.synctera.com/v0/accounts/{account_id}/relationships"
payload = {
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deleted_at": "2023-11-07T05:31:56Z",
"ownership_percentage": 35.75,
"person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z"
}
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: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
created_at: '2023-11-07T05:31:56Z',
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
deleted_at: '2023-11-07T05:31:56Z',
ownership_percentage: 35.75,
person_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
updated_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api-sandbox.synctera.com/v0/accounts/{account_id}/relationships', 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/accounts/{account_id}/relationships",
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' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'created_at' => '2023-11-07T05:31:56Z',
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'deleted_at' => '2023-11-07T05:31:56Z',
'ownership_percentage' => 35.75,
'person_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'updated_at' => '2023-11-07T05:31:56Z'
]),
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/accounts/{account_id}/relationships"
payload := strings.NewReader("{\n \"business_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"deleted_at\": \"2023-11-07T05:31:56Z\",\n \"ownership_percentage\": 35.75,\n \"person_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"updated_at\": \"2023-11-07T05:31:56Z\"\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/accounts/{account_id}/relationships")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"business_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"deleted_at\": \"2023-11-07T05:31:56Z\",\n \"ownership_percentage\": 35.75,\n \"person_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/accounts/{account_id}/relationships")
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\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"deleted_at\": \"2023-11-07T05:31:56Z\",\n \"ownership_percentage\": 35.75,\n \"person_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"relationship_type": "ACCOUNT_HOLDER",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deleted_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ownership_percentage": 35.75,
"person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z"
}{
"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"
}Accounts
Create account relationship
Add a customer to an account
POST
/
accounts
/
{account_id}
/
relationships
Create account relationship
curl --request POST \
--url https://api-sandbox.synctera.com/v0/accounts/{account_id}/relationships \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deleted_at": "2023-11-07T05:31:56Z",
"ownership_percentage": 35.75,
"person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api-sandbox.synctera.com/v0/accounts/{account_id}/relationships"
payload = {
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deleted_at": "2023-11-07T05:31:56Z",
"ownership_percentage": 35.75,
"person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z"
}
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: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
created_at: '2023-11-07T05:31:56Z',
customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
deleted_at: '2023-11-07T05:31:56Z',
ownership_percentage: 35.75,
person_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
updated_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api-sandbox.synctera.com/v0/accounts/{account_id}/relationships', 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/accounts/{account_id}/relationships",
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' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'created_at' => '2023-11-07T05:31:56Z',
'customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'deleted_at' => '2023-11-07T05:31:56Z',
'ownership_percentage' => 35.75,
'person_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'updated_at' => '2023-11-07T05:31:56Z'
]),
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/accounts/{account_id}/relationships"
payload := strings.NewReader("{\n \"business_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"deleted_at\": \"2023-11-07T05:31:56Z\",\n \"ownership_percentage\": 35.75,\n \"person_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"updated_at\": \"2023-11-07T05:31:56Z\"\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/accounts/{account_id}/relationships")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"business_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"deleted_at\": \"2023-11-07T05:31:56Z\",\n \"ownership_percentage\": 35.75,\n \"person_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/accounts/{account_id}/relationships")
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\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"deleted_at\": \"2023-11-07T05:31:56Z\",\n \"ownership_percentage\": 35.75,\n \"person_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"updated_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"relationship_type": "ACCOUNT_HOLDER",
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deleted_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ownership_percentage": 35.75,
"person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z"
}{
"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"
Path Parameters
Unique identifier for the account.
Example:
"57826c51-e4ff-4e57-9558-08cab6b963c7"
Body
application/json
Account relationship object
The relationship of the account and the customer/business. Either customer_id OR business_id must be specified, but not both.
Relationship type
Available options:
ACCOUNT_HOLDER, AUTHORIZED_SIGNER, AUTHORIZED_USER, BENEFICIARY, JOINT_ACCOUNT_HOLDER, PRIMARY_ACCOUNT_HOLDER Business associated with the current account. One of business_id or customer_id must be specified.
Date and time when this association was created.
Personal customer associated with the current account. One of customer_id or business_id must be specified.
Date and time when this association was deleted.
The ownership percentage of the related party.
Required range:
0 <= x <= 100Example:
35.75
Person associated with the current account. This attribute is deprecated and will be removed in a future API version. Use customer_id instead.
Date and time when this association was last updated.
Response
Account relationship object
The relationship of the account and the customer/business.
Relationship type
Available options:
ACCOUNT_HOLDER, AUTHORIZED_SIGNER, AUTHORIZED_USER, BENEFICIARY, JOINT_ACCOUNT_HOLDER, PRIMARY_ACCOUNT_HOLDER Account ID
Business associated with the current account. One of business_id or customer_id must be specified.
Date and time when this association was created.
Personal customer associated with the current account. One of customer_id or business_id must be specified.
Date and time when this association was deleted.
ID of account relationship
The ownership percentage of the related party.
Required range:
0 <= x <= 100Example:
35.75
Person associated with the current account. This attribute is deprecated and will be removed in a future API version. Use customer_id instead.
Date and time when this association was last updated.
Was this page helpful?