Get person

curl --request GET \
  --url https://api.synctera.com/v2/persons/{person_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v2/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.synctera.com/v2/persons/{person_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synctera.com/v2/persons/{person_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/persons/{person_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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",
  "phone_number": "+14374570680",
  "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",
  "verification_last_run": "2010-05-06T12:23:34.321Z",
  "personal_ids": [
    {
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "id_type": "SSN",
      "identifier": "123-45-6789",
      "system_provided": true,
      "country_code": "<string>",
      "expiry_date": "2020-01-01",
      "issue_date": "2020-01-01"
    }
  ],
  "classifications": [],
  "vendor_info": {
    "vendor_data": {
      "loanpro": {
        "customer_id": 12345
      }
    },
    "vendor_type": "LOANPRO"
  }
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

GET

persons

{person_id}

Get person

curl --request GET \
  --url https://api.synctera.com/v2/persons/{person_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.synctera.com/v2/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.synctera.com/v2/persons/{person_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.synctera.com/v2/persons/{person_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.synctera.com/v2/persons/{person_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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",
  "phone_number": "+14374570680",
  "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",
  "verification_last_run": "2010-05-06T12:23:34.321Z",
  "personal_ids": [
    {
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "id_type": "SSN",
      "identifier": "123-45-6789",
      "system_provided": true,
      "country_code": "<string>",
      "expiry_date": "2020-01-01",
      "issue_date": "2020-01-01"
    }
  ],
  "classifications": [],
  "vendor_info": {
    "vendor_data": {
      "loanpro": {
        "customer_id": 12345
      }
    },
    "vendor_type": "LOANPRO"
  }
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

{
  "code": "BAD_REQUEST_BODY",
  "detail": "Missing required fields: first_name, dob",
  "status": 400
}

Authorizations

Authorization

string

header

required

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

Path Parameters

person_id

string<uuid>

required

Person's unique identifier.

Example:

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

Response

Person representation.

Details of a person

ban_status

enum<string>

required

(beta) Ban status of the person. One of the following:

ALLOWED – person is not banned or suspended
SUSPENDED - person is manually suspended due to fraud
BANNED – 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.

Available options:

ALLOWED,

BANNED,

SUSPENDED

Example:

"ALLOWED"

creation_time

string<date-time>

required

read-only

The date and time the resource was created.

Example:

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

string<uuid>

required

read-only

Person's unique identifier.

Example:

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

is_customer

boolean

required

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.

Example:

true

last_updated_time

string<date-time>

required

read-only

The date and time the resource was last updated.

Example:

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

status

enum<string>

required

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.

Available options:

ACTIVE,

DECEASED,

DENIED,

DORMANT,

ESCHEAT,

FROZEN,

INACTIVE,

PROSPECT,

SANCTION

Example:

"ACTIVE"

tenant

string

required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

verification_status

enum<string>

required

read-only

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.

Available options:

UNVERIFIED,

PENDING,

PROVISIONAL,

ACCEPTED,

REVIEW,

REJECTED

Example:

"ACCEPTED"

chosen_name

string

Person's chosen name.

Example:

"Annie"

customer_active

string<date-time>

read-only

The date and time this person became a bank customer.

Example:

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

dob

string<date>

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.

Example:

"2000-01-01"

string

Person's email.

Example:

"alice@example.com"

first_name

string

Person's first name.

Example:

"Jane"

has_accounts

boolean

read-only

This flag indicates whether the person or business has accounts.

is_user

boolean

read-only

True for console users. Set this to true for any users direct access to the Synctera console.

Example:

true

last_name

string

Person's last name.

Example:

"Smith"

legal_address

object

Legal address

Show child attributes

metadata

object

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

middle_name

string

Person's middle name.

Example:

"Anne"

phone_number

string

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

Pattern: ^\+[1-9]\d{1,14}$

Example:

"+14374570680"

shipping_address

object

Shipping address

Show child attributes

spend_control_ids

string<uuid>[]

List of spend control IDs to control spending for the customer

Maximum array length: 100

ssn

string

Person's full tax ID eg SSN formatted with hyphens. The response contains the last 4 digits only (e.g. 6789).

Example:

"123-45-6789"

ssn_source

enum<string>

read-only

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.

Available options:

MANUAL,

PREFILL

verification_last_run

string<date-time>

read-only

Date and time KYC verification was last run on the person.

Example:

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

personal_ids

object[]

Array of personal identifiers

Show child attributes

classifications

enum<string>[]

read-only

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.

Available options:

BANK_CUSTOMER,

AUTHORIZED_USER,

PROSPECT,

INACTIVE_BANK_CUSTOMER

vendor_info

object

Vendor information for external account management systems

Show child attributes

⌘I

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Get person

Authorizations

Path Parameters

Response