curl --request PATCH \
--url https://api-sandbox.synctera.com/v0/persons/{person_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"note": "<string>",
"ban_status": "ALLOWED",
"chosen_name": "Annie",
"dob": "2000-01-01",
"email": "alice@example.com",
"first_name": "Jane",
"is_customer": true,
"last_name": "Smith",
"metadata": {},
"middle_name": "Anne",
"military_status_reason": "Active duty orders received 2026-01-02",
"mla_applicable_date": {
"start_date": "2026-01-01",
"end_date": "2026-12-31"
},
"phone_number": "+14374570680",
"scra_applicable_date": {
"start_date": "2026-01-01",
"end_date": "2026-12-31"
},
"spend_control_ids": [
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
],
"ssn": "123-45-6789",
"status": "ACTIVE",
"tenant": "abcdef_ghijkl"
}
'import requests
url = "https://api-sandbox.synctera.com/v0/persons/{person_id}"
payload = {
"note": "<string>",
"ban_status": "ALLOWED",
"chosen_name": "Annie",
"dob": "2000-01-01",
"email": "alice@example.com",
"first_name": "Jane",
"is_customer": True,
"last_name": "Smith",
"metadata": {},
"middle_name": "Anne",
"military_status_reason": "Active duty orders received 2026-01-02",
"mla_applicable_date": {
"start_date": "2026-01-01",
"end_date": "2026-12-31"
},
"phone_number": "+14374570680",
"scra_applicable_date": {
"start_date": "2026-01-01",
"end_date": "2026-12-31"
},
"spend_control_ids": ["7d943c51-e4ff-4e57-9558-08cab6b963c7"],
"ssn": "123-45-6789",
"status": "ACTIVE",
"tenant": "abcdef_ghijkl"
}
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({
note: '<string>',
ban_status: 'ALLOWED',
chosen_name: 'Annie',
dob: '2000-01-01',
email: 'alice@example.com',
first_name: 'Jane',
is_customer: true,
last_name: 'Smith',
metadata: {},
middle_name: 'Anne',
military_status_reason: 'Active duty orders received 2026-01-02',
mla_applicable_date: {start_date: '2026-01-01', end_date: '2026-12-31'},
phone_number: '+14374570680',
scra_applicable_date: {start_date: '2026-01-01', end_date: '2026-12-31'},
spend_control_ids: ['7d943c51-e4ff-4e57-9558-08cab6b963c7'],
ssn: '123-45-6789',
status: 'ACTIVE',
tenant: 'abcdef_ghijkl'
})
};
fetch('https://api-sandbox.synctera.com/v0/persons/{person_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/persons/{person_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([
'note' => '<string>',
'ban_status' => 'ALLOWED',
'chosen_name' => 'Annie',
'dob' => '2000-01-01',
'email' => 'alice@example.com',
'first_name' => 'Jane',
'is_customer' => true,
'last_name' => 'Smith',
'metadata' => [
],
'middle_name' => 'Anne',
'military_status_reason' => 'Active duty orders received 2026-01-02',
'mla_applicable_date' => [
'start_date' => '2026-01-01',
'end_date' => '2026-12-31'
],
'phone_number' => '+14374570680',
'scra_applicable_date' => [
'start_date' => '2026-01-01',
'end_date' => '2026-12-31'
],
'spend_control_ids' => [
'7d943c51-e4ff-4e57-9558-08cab6b963c7'
],
'ssn' => '123-45-6789',
'status' => 'ACTIVE',
'tenant' => 'abcdef_ghijkl'
]),
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/persons/{person_id}"
payload := strings.NewReader("{\n \"note\": \"<string>\",\n \"ban_status\": \"ALLOWED\",\n \"chosen_name\": \"Annie\",\n \"dob\": \"2000-01-01\",\n \"email\": \"alice@example.com\",\n \"first_name\": \"Jane\",\n \"is_customer\": true,\n \"last_name\": \"Smith\",\n \"metadata\": {},\n \"middle_name\": \"Anne\",\n \"military_status_reason\": \"Active duty orders received 2026-01-02\",\n \"mla_applicable_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-31\"\n },\n \"phone_number\": \"+14374570680\",\n \"scra_applicable_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-31\"\n },\n \"spend_control_ids\": [\n \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n ],\n \"ssn\": \"123-45-6789\",\n \"status\": \"ACTIVE\",\n \"tenant\": \"abcdef_ghijkl\"\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/persons/{person_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"note\": \"<string>\",\n \"ban_status\": \"ALLOWED\",\n \"chosen_name\": \"Annie\",\n \"dob\": \"2000-01-01\",\n \"email\": \"alice@example.com\",\n \"first_name\": \"Jane\",\n \"is_customer\": true,\n \"last_name\": \"Smith\",\n \"metadata\": {},\n \"middle_name\": \"Anne\",\n \"military_status_reason\": \"Active duty orders received 2026-01-02\",\n \"mla_applicable_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-31\"\n },\n \"phone_number\": \"+14374570680\",\n \"scra_applicable_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-31\"\n },\n \"spend_control_ids\": [\n \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n ],\n \"ssn\": \"123-45-6789\",\n \"status\": \"ACTIVE\",\n \"tenant\": \"abcdef_ghijkl\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/persons/{person_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 \"note\": \"<string>\",\n \"ban_status\": \"ALLOWED\",\n \"chosen_name\": \"Annie\",\n \"dob\": \"2000-01-01\",\n \"email\": \"alice@example.com\",\n \"first_name\": \"Jane\",\n \"is_customer\": true,\n \"last_name\": \"Smith\",\n \"metadata\": {},\n \"middle_name\": \"Anne\",\n \"military_status_reason\": \"Active duty orders received 2026-01-02\",\n \"mla_applicable_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-31\"\n },\n \"phone_number\": \"+14374570680\",\n \"scra_applicable_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-31\"\n },\n \"spend_control_ids\": [\n \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n ],\n \"ssn\": \"123-45-6789\",\n \"status\": \"ACTIVE\",\n \"tenant\": \"abcdef_ghijkl\"\n}"
response = http.request(request)
puts response.read_body{
"ban_status": "ALLOWED",
"creation_time": "2010-05-06T12:23:34.321Z",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_customer": true,
"last_updated_time": "2010-05-06T12:23:34.321Z",
"status": "ACTIVE",
"tenant": "abcdef_ghijkl",
"verification_status": "ACCEPTED",
"chosen_name": "Annie",
"customer_active": "2010-05-06T12:23:34.321Z",
"dob": "2000-01-01",
"email": "alice@example.com",
"first_name": "Jane",
"has_accounts": true,
"is_user": true,
"last_name": "Smith",
"legal_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"
},
"metadata": {},
"middle_name": "Anne",
"mla_applicable_date": {
"start_date": "2026-01-01",
"end_date": "2026-12-31"
},
"mla_history": [
{
"changed_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"changed_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"end_date": "2026-12-31",
"impersonated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "2026-01-01"
}
],
"phone_number": "+14374570680",
"scra_applicable_date": {
"start_date": "2026-01-01",
"end_date": "2026-12-31"
},
"scra_history": [
{
"changed_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"changed_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"end_date": "2026-12-31",
"impersonated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "2026-01-01"
}
],
"shipping_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"
},
"spend_control_ids": [
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
],
"ssn": "123-45-6789",
"ssn_source": "MANUAL",
"verification_last_run": "2010-05-06T12:23:34.321Z",
"classifications": [
"AUTHORIZED_USER"
],
"vendor_info": {
"vendor_data": {
"loanpro": {
"customer_id": 12345
}
},
"vendor_type": "LOANPRO"
},
"personal_ids": [
{
"country_code": "<string>",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"id_type": "SSN",
"identifier": "123-45-6789",
"system_provided": true,
"expiry_date": "2020-01-01",
"issue_date": "2020-01-01"
}
]
}{
"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"
}Update person
Update person by ID.
Note that if:
- legal address is provided in the request, AND
- shipping_address is not provided in the request, AND
- the customer resource does not have shipping_address then shipping_address will be set to a copy of the legal_address.
curl --request PATCH \
--url https://api-sandbox.synctera.com/v0/persons/{person_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"note": "<string>",
"ban_status": "ALLOWED",
"chosen_name": "Annie",
"dob": "2000-01-01",
"email": "alice@example.com",
"first_name": "Jane",
"is_customer": true,
"last_name": "Smith",
"metadata": {},
"middle_name": "Anne",
"military_status_reason": "Active duty orders received 2026-01-02",
"mla_applicable_date": {
"start_date": "2026-01-01",
"end_date": "2026-12-31"
},
"phone_number": "+14374570680",
"scra_applicable_date": {
"start_date": "2026-01-01",
"end_date": "2026-12-31"
},
"spend_control_ids": [
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
],
"ssn": "123-45-6789",
"status": "ACTIVE",
"tenant": "abcdef_ghijkl"
}
'import requests
url = "https://api-sandbox.synctera.com/v0/persons/{person_id}"
payload = {
"note": "<string>",
"ban_status": "ALLOWED",
"chosen_name": "Annie",
"dob": "2000-01-01",
"email": "alice@example.com",
"first_name": "Jane",
"is_customer": True,
"last_name": "Smith",
"metadata": {},
"middle_name": "Anne",
"military_status_reason": "Active duty orders received 2026-01-02",
"mla_applicable_date": {
"start_date": "2026-01-01",
"end_date": "2026-12-31"
},
"phone_number": "+14374570680",
"scra_applicable_date": {
"start_date": "2026-01-01",
"end_date": "2026-12-31"
},
"spend_control_ids": ["7d943c51-e4ff-4e57-9558-08cab6b963c7"],
"ssn": "123-45-6789",
"status": "ACTIVE",
"tenant": "abcdef_ghijkl"
}
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({
note: '<string>',
ban_status: 'ALLOWED',
chosen_name: 'Annie',
dob: '2000-01-01',
email: 'alice@example.com',
first_name: 'Jane',
is_customer: true,
last_name: 'Smith',
metadata: {},
middle_name: 'Anne',
military_status_reason: 'Active duty orders received 2026-01-02',
mla_applicable_date: {start_date: '2026-01-01', end_date: '2026-12-31'},
phone_number: '+14374570680',
scra_applicable_date: {start_date: '2026-01-01', end_date: '2026-12-31'},
spend_control_ids: ['7d943c51-e4ff-4e57-9558-08cab6b963c7'],
ssn: '123-45-6789',
status: 'ACTIVE',
tenant: 'abcdef_ghijkl'
})
};
fetch('https://api-sandbox.synctera.com/v0/persons/{person_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/persons/{person_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([
'note' => '<string>',
'ban_status' => 'ALLOWED',
'chosen_name' => 'Annie',
'dob' => '2000-01-01',
'email' => 'alice@example.com',
'first_name' => 'Jane',
'is_customer' => true,
'last_name' => 'Smith',
'metadata' => [
],
'middle_name' => 'Anne',
'military_status_reason' => 'Active duty orders received 2026-01-02',
'mla_applicable_date' => [
'start_date' => '2026-01-01',
'end_date' => '2026-12-31'
],
'phone_number' => '+14374570680',
'scra_applicable_date' => [
'start_date' => '2026-01-01',
'end_date' => '2026-12-31'
],
'spend_control_ids' => [
'7d943c51-e4ff-4e57-9558-08cab6b963c7'
],
'ssn' => '123-45-6789',
'status' => 'ACTIVE',
'tenant' => 'abcdef_ghijkl'
]),
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/persons/{person_id}"
payload := strings.NewReader("{\n \"note\": \"<string>\",\n \"ban_status\": \"ALLOWED\",\n \"chosen_name\": \"Annie\",\n \"dob\": \"2000-01-01\",\n \"email\": \"alice@example.com\",\n \"first_name\": \"Jane\",\n \"is_customer\": true,\n \"last_name\": \"Smith\",\n \"metadata\": {},\n \"middle_name\": \"Anne\",\n \"military_status_reason\": \"Active duty orders received 2026-01-02\",\n \"mla_applicable_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-31\"\n },\n \"phone_number\": \"+14374570680\",\n \"scra_applicable_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-31\"\n },\n \"spend_control_ids\": [\n \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n ],\n \"ssn\": \"123-45-6789\",\n \"status\": \"ACTIVE\",\n \"tenant\": \"abcdef_ghijkl\"\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/persons/{person_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"note\": \"<string>\",\n \"ban_status\": \"ALLOWED\",\n \"chosen_name\": \"Annie\",\n \"dob\": \"2000-01-01\",\n \"email\": \"alice@example.com\",\n \"first_name\": \"Jane\",\n \"is_customer\": true,\n \"last_name\": \"Smith\",\n \"metadata\": {},\n \"middle_name\": \"Anne\",\n \"military_status_reason\": \"Active duty orders received 2026-01-02\",\n \"mla_applicable_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-31\"\n },\n \"phone_number\": \"+14374570680\",\n \"scra_applicable_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-31\"\n },\n \"spend_control_ids\": [\n \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n ],\n \"ssn\": \"123-45-6789\",\n \"status\": \"ACTIVE\",\n \"tenant\": \"abcdef_ghijkl\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/persons/{person_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 \"note\": \"<string>\",\n \"ban_status\": \"ALLOWED\",\n \"chosen_name\": \"Annie\",\n \"dob\": \"2000-01-01\",\n \"email\": \"alice@example.com\",\n \"first_name\": \"Jane\",\n \"is_customer\": true,\n \"last_name\": \"Smith\",\n \"metadata\": {},\n \"middle_name\": \"Anne\",\n \"military_status_reason\": \"Active duty orders received 2026-01-02\",\n \"mla_applicable_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-31\"\n },\n \"phone_number\": \"+14374570680\",\n \"scra_applicable_date\": {\n \"start_date\": \"2026-01-01\",\n \"end_date\": \"2026-12-31\"\n },\n \"spend_control_ids\": [\n \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n ],\n \"ssn\": \"123-45-6789\",\n \"status\": \"ACTIVE\",\n \"tenant\": \"abcdef_ghijkl\"\n}"
response = http.request(request)
puts response.read_body{
"ban_status": "ALLOWED",
"creation_time": "2010-05-06T12:23:34.321Z",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"is_customer": true,
"last_updated_time": "2010-05-06T12:23:34.321Z",
"status": "ACTIVE",
"tenant": "abcdef_ghijkl",
"verification_status": "ACCEPTED",
"chosen_name": "Annie",
"customer_active": "2010-05-06T12:23:34.321Z",
"dob": "2000-01-01",
"email": "alice@example.com",
"first_name": "Jane",
"has_accounts": true,
"is_user": true,
"last_name": "Smith",
"legal_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"
},
"metadata": {},
"middle_name": "Anne",
"mla_applicable_date": {
"start_date": "2026-01-01",
"end_date": "2026-12-31"
},
"mla_history": [
{
"changed_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"changed_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"end_date": "2026-12-31",
"impersonated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "2026-01-01"
}
],
"phone_number": "+14374570680",
"scra_applicable_date": {
"start_date": "2026-01-01",
"end_date": "2026-12-31"
},
"scra_history": [
{
"changed_at": "2023-11-07T05:31:56Z",
"reason": "<string>",
"changed_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"end_date": "2026-12-31",
"impersonated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "2026-01-01"
}
],
"shipping_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"
},
"spend_control_ids": [
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
],
"ssn": "123-45-6789",
"ssn_source": "MANUAL",
"verification_last_run": "2010-05-06T12:23:34.321Z",
"classifications": [
"AUTHORIZED_USER"
],
"vendor_info": {
"vendor_data": {
"loanpro": {
"customer_id": 12345
}
},
"vendor_type": "LOANPRO"
},
"personal_ids": [
{
"country_code": "<string>",
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"id_type": "SSN",
"identifier": "123-45-6789",
"system_provided": true,
"expiry_date": "2020-01-01",
"issue_date": "2020-01-01"
}
]
}{
"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.
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Path Parameters
Person's unique identifier.
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Body
Properties of a person that can be updated
Text to be added to a note when updating a person. A note is required when changing a person's ban_status between SUSPENDED and ALLOWED.
Vendor information for external account management systems
Show child attributes
Show child attributes
(beta) Ban status of the person. One of the following:
ALLOWED– person is not banned or suspendedSUSPENDED- person is manually suspended due to fraudBANNED– person is banned due to matching ban rules Note: changing the ban status to or from BANNED can only be performed by the Synctera platform based on ban rules.
ALLOWED, BANNED, SUSPENDED "ALLOWED"
Person's chosen name.
"Annie"
Person's date of birth in RFC 3339 full-date format (YYYY-MM-DD). Must be on or after 1900-01-01 and before current date.
"2000-01-01"
Person's email.
"alice@example.com"
Person's first name.
"Jane"
True for personal and business customers with a direct relationship with the fintech or bank. Set this to true for any customer related to an account.
true
Person's last name.
"Smith"
Legal address
Show child attributes
Show child attributes
Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
Person's middle name.
"Anne"
Why the MLA or SCRA range is being changed (for example the basis or evidence). Required when the request sets, changes or clears mla_applicable_date or scra_applicable_date, and recorded in the history of whichever of MLA or SCRA changed. Never returned.
"Active duty orders received 2026-01-02"
The calendar date range during which the protection applies to the person. Both dates are inclusive and the status is customer-wide. The protection applies today when today falls within the range. Not set means no range is recorded. On PATCH, an object replaces the whole range, null clears it, and omitting the property leaves it unchanged. A change requires military_status_reason.
Show child attributes
Show child attributes
Person's mobile phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated
^\+[1-9]\d{1,14}$"+14374570680"
The calendar date range during which the protection applies to the person. Both dates are inclusive and the status is customer-wide. The protection applies today when today falls within the range. Not set means no range is recorded. On PATCH, an object replaces the whole range, null clears it, and omitting the property leaves it unchanged. A change requires military_status_reason.
Show child attributes
Show child attributes
Shipping address
Show child attributes
Show child attributes
List of spend control IDs to control spending for the customer
100Person's full tax ID eg SSN formatted with hyphens. The response contains the last 4 digits only (e.g. 6789).
"123-45-6789"
Status of the person. One of the following:
ACTIVE– is an integrator defined status. Integrators should set a person to active if they believe the person to be qualified for conducting business. Synctera will combine this status with other statuses such a verification to determine if the person is eligible for specific actions such as initiating transactions or issuing a card.DECEASED– person is deceased.DENIED– customer was turned down.DORMANT– person is no longer active.ESCHEAT– person's assets are abandoned and are property of the state.FROZEN– person's actions are blocked for security, legal, or other reasons.INACTIVE– an inactive status indicating that the person is no longer active.PROSPECT– a potential customer, used for information-gathering and disclosures.SANCTION– person is on a sanctions list and should be carefully monitored.
ACTIVE, DECEASED, DENIED, DORMANT, ESCHEAT, FROZEN, INACTIVE, PROSPECT, SANCTION "ACTIVE"
The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
"abcdef_ghijkl"
Response
Updated person representation.
Details of a person
(beta) Ban status of the person. One of the following:
ALLOWED– person is not banned or suspendedSUSPENDED- person is manually suspended due to fraudBANNED– person is banned due to matching ban rules Note: changing the ban status to or from BANNED can only be performed by the Synctera platform based on ban rules.
ALLOWED, BANNED, SUSPENDED "ALLOWED"
The date and time the resource was created.
"2010-05-06T12:23:34.321Z"
Person's unique identifier.
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
True for personal and business customers with a direct relationship with the fintech or bank. Set this to true for any customer related to an account.
true
The date and time the resource was last updated.
"2010-05-06T12:23:34.321Z"
Status of the person. One of the following:
ACTIVE– is an integrator defined status. Integrators should set a person to active if they believe the person to be qualified for conducting business. Synctera will combine this status with other statuses such a verification to determine if the person is eligible for specific actions such as initiating transactions or issuing a card.DECEASED– person is deceased.DENIED– customer was turned down.DORMANT– person is no longer active.ESCHEAT– person's assets are abandoned and are property of the state.FROZEN– person's actions are blocked for security, legal, or other reasons.INACTIVE– an inactive status indicating that the person is no longer active.PROSPECT– a potential customer, used for information-gathering and disclosures.SANCTION– person is on a sanctions list and should be carefully monitored.
ACTIVE, DECEASED, DENIED, DORMANT, ESCHEAT, FROZEN, INACTIVE, PROSPECT, SANCTION "ACTIVE"
The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
"abcdef_ghijkl"
The result of a KYC/KYB verification. One of the following:
UNVERIFIED– verification has not been completed for this customer.PENDING– verification is in progress for this customer.PROVISIONAL– partially verified or verified with restrictions.ACCEPTED– the customer has been verified.REVIEW– verification has run and issues have been identified and require review.REJECTED– the customer was rejected and should not be allowed to take certain actions e.g., open an account.
ACCEPTED, PENDING, PROVISIONAL, REJECTED, REVIEW, UNVERIFIED "ACCEPTED"
Person's chosen name.
"Annie"
The date and time this person became a bank customer.
"2010-05-06T12:23:34.321Z"
Person's date of birth in RFC 3339 full-date format (YYYY-MM-DD). Must be on or after 1900-01-01 and before current date.
"2000-01-01"
Person's email.
"alice@example.com"
Person's first name.
"Jane"
This flag indicates whether the person or business has accounts.
True for console users. Set this to true for any users direct access to the Synctera console.
true
Person's last name.
"Smith"
Legal address
Show child attributes
Show child attributes
Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
Person's middle name.
"Anne"
The calendar date range during which the protection applies to the person. Both dates are inclusive and the status is customer-wide. The protection applies today when today falls within the range. Not set means no range is recorded. On PATCH, an object replaces the whole range, null clears it, and omitting the property leaves it unchanged. A change requires military_status_reason.
Show child attributes
Show child attributes
Append-only record of every change to the range, oldest first. Read-only; values in requests are ignored.
Show child attributes
Show child attributes
Person's mobile phone number with country code in E.164 format. Must have a valid country code. Area code and local phone number are not validated
^\+[1-9]\d{1,14}$"+14374570680"
The calendar date range during which the protection applies to the person. Both dates are inclusive and the status is customer-wide. The protection applies today when today falls within the range. Not set means no range is recorded. On PATCH, an object replaces the whole range, null clears it, and omitting the property leaves it unchanged. A change requires military_status_reason.
Show child attributes
Show child attributes
Append-only record of every change to the range, oldest first. Read-only; values in requests are ignored.
Show child attributes
Show child attributes
Shipping address
Show child attributes
Show child attributes
List of spend control IDs to control spending for the customer
100Person's full tax ID eg SSN formatted with hyphens. The response contains the last 4 digits only (e.g. 6789).
"123-45-6789"
Describes the collection method for the customer's SSN:
MANUAL– the full 9 digits of the customer's SSN was collected.PREFILL– the customer's SSN was collected using SSN Prefill.
MANUAL, PREFILL Date and time KYC verification was last run on the person.
"2010-05-06T12:23:34.321Z"
Specifies the classification of a party for banks. This may contain multiple values for a combined classifications list of customers.
Specifies the classification of a party.
AUTHORIZED_USER, BANK_CUSTOMER, INACTIVE_BANK_CUSTOMER, PROSPECT Vendor information for external account management systems
Show child attributes
Show child attributes
Array of personal identifiers
Show child attributes
Show child attributes
Was this page helpful?