Update relationship

curl --request PATCH \
  --url https://api-sandbox.synctera.com/v0/relationships/{relationship_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "relationship_type": "BENEFICIAL_OWNER_OF",
  "from_person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "metadata": {},
  "tenant": "abcdef_ghijkl",
  "to_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}
'

import requests

url = "https://api-sandbox.synctera.com/v0/relationships/{relationship_id}"

payload = {
    "relationship_type": "BENEFICIAL_OWNER_OF",
    "from_person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "metadata": {},
    "tenant": "abcdef_ghijkl",
    "to_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    relationship_type: 'BENEFICIAL_OWNER_OF',
    from_person_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    metadata: {},
    tenant: 'abcdef_ghijkl',
    to_business_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7'
  })
};

fetch('https://api-sandbox.synctera.com/v0/relationships/{relationship_id}', 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/relationships/{relationship_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'relationship_type' => 'BENEFICIAL_OWNER_OF',
    'from_person_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    'metadata' => [
        
    ],
    'tenant' => 'abcdef_ghijkl',
    'to_business_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7'
  ]),
  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/relationships/{relationship_id}"

	payload := strings.NewReader("{\n  \"relationship_type\": \"BENEFICIAL_OWNER_OF\",\n  \"from_person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"metadata\": {},\n  \"tenant\": \"abcdef_ghijkl\",\n  \"to_business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api-sandbox.synctera.com/v0/relationships/{relationship_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"relationship_type\": \"BENEFICIAL_OWNER_OF\",\n  \"from_person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"metadata\": {},\n  \"tenant\": \"abcdef_ghijkl\",\n  \"to_business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.synctera.com/v0/relationships/{relationship_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"relationship_type\": \"BENEFICIAL_OWNER_OF\",\n  \"from_person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"metadata\": {},\n  \"tenant\": \"abcdef_ghijkl\",\n  \"to_business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n}"

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

{
  "relationship_type": "BENEFICIAL_OWNER_OF",
  "additional_data": {
    "title": "OFFICER",
    "title_other": "Controller"
  },
  "creation_time": "2010-05-06T12:23:34.321Z",
  "from_person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "metadata": {},
  "tenant": "abcdef_ghijkl",
  "to_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}

{
  "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"
}

{
  "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"
}

PATCH

relationships

{relationship_id}

Update relationship

curl --request PATCH \
  --url https://api-sandbox.synctera.com/v0/relationships/{relationship_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "relationship_type": "BENEFICIAL_OWNER_OF",
  "from_person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "metadata": {},
  "tenant": "abcdef_ghijkl",
  "to_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}
'

import requests

url = "https://api-sandbox.synctera.com/v0/relationships/{relationship_id}"

payload = {
    "relationship_type": "BENEFICIAL_OWNER_OF",
    "from_person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
    "metadata": {},
    "tenant": "abcdef_ghijkl",
    "to_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    relationship_type: 'BENEFICIAL_OWNER_OF',
    from_person_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    metadata: {},
    tenant: 'abcdef_ghijkl',
    to_business_id: '7d943c51-e4ff-4e57-9558-08cab6b963c7'
  })
};

fetch('https://api-sandbox.synctera.com/v0/relationships/{relationship_id}', 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/relationships/{relationship_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'relationship_type' => 'BENEFICIAL_OWNER_OF',
    'from_person_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
    'metadata' => [
        
    ],
    'tenant' => 'abcdef_ghijkl',
    'to_business_id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7'
  ]),
  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/relationships/{relationship_id}"

	payload := strings.NewReader("{\n  \"relationship_type\": \"BENEFICIAL_OWNER_OF\",\n  \"from_person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"metadata\": {},\n  \"tenant\": \"abcdef_ghijkl\",\n  \"to_business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api-sandbox.synctera.com/v0/relationships/{relationship_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"relationship_type\": \"BENEFICIAL_OWNER_OF\",\n  \"from_person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"metadata\": {},\n  \"tenant\": \"abcdef_ghijkl\",\n  \"to_business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.synctera.com/v0/relationships/{relationship_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"relationship_type\": \"BENEFICIAL_OWNER_OF\",\n  \"from_person_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n  \"metadata\": {},\n  \"tenant\": \"abcdef_ghijkl\",\n  \"to_business_id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n}"

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

{
  "relationship_type": "BENEFICIAL_OWNER_OF",
  "additional_data": {
    "title": "OFFICER",
    "title_other": "Controller"
  },
  "creation_time": "2010-05-06T12:23:34.321Z",
  "from_person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "metadata": {},
  "tenant": "abcdef_ghijkl",
  "to_business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7"
}

{
  "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"
}

{
  "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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

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

relationship_id

string<uuid>

required

Relationship ID of the account associate with the account entity

Example:

"1a582c51-e4ff-4e57-9558-08cab6b963aa"

Body

application/json

Managing Person
Business Owner
Beneficial Owner
Payer/Payee

Denotes the relationship between specified person and business.

relationship_type

enum<string>

required

The relationship type. One of the following:

BENEFICIAL_OWNER_OF – a person who directly or indirectly owns a portion of the business.
MANAGING_PERSON_OF – a person who is an officer, director, or other notable person of an organization.
OWNER_OF – a business with ownership of another business.
PAYER_PAYEE - a person or business with a payer payee relationship with another person or business

Available options:

BENEFICIAL_OWNER_OF,

MANAGING_PERSON_OF,

OWNER_OF,

PAYER_PAYEE

Example:

"BENEFICIAL_OWNER_OF"

additional_data

object

Contains additional information about the relationship.

Show child attributes

from_person_id

string<uuid>

Unique ID for the subject person.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

metadata

object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

tenant

string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

to_business_id

string<uuid>

Unique ID for the related business.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Response

Updated relationship representation.

Managing Person
Business Owner
Beneficial Owner
Payer/Payee

Denotes the relationship between specified person and business.

relationship_type

enum<string>

required

The relationship type. One of the following:

BENEFICIAL_OWNER_OF – a person who directly or indirectly owns a portion of the business.
MANAGING_PERSON_OF – a person who is an officer, director, or other notable person of an organization.
OWNER_OF – a business with ownership of another business.
PAYER_PAYEE - a person or business with a payer payee relationship with another person or business

Available options:

BENEFICIAL_OWNER_OF,

MANAGING_PERSON_OF,

OWNER_OF,

PAYER_PAYEE

Example:

"BENEFICIAL_OWNER_OF"

additional_data

object

Contains additional information about the relationship.

Show child attributes

creation_time

string<date-time>

read-only

The date and time the resource was created.

Example:

"2010-05-06T12:23:34.321Z"

from_person_id

string<uuid>

Unique ID for the subject person.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

string<uuid>

read-only

Relationship unique identifier.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

last_updated_time

string<date-time>

read-only

The date and time the resource was last updated.

Example:

"2010-05-06T12:23:34.321Z"

metadata

object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

tenant

string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

to_business_id

string<uuid>

Unique ID for the related business.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Deprecated

Update relationship

Authorizations

Headers

Path Parameters

Body

Response