List Customers

curl --request GET \
  --url https://api-sandbox.synctera.com/v0/customers \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api-sandbox.synctera.com/v0/customers', 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/customers",
  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-sandbox.synctera.com/v0/customers"

	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-sandbox.synctera.com/v0/customers")

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

{
  "customers": [
    {
      "vendor_info": {
        "vendor_data": {
          "loanpro": {
            "customer_id": 12345
          }
        },
        "vendor_type": "LOANPRO"
      },
      "addresses": [
        {
          "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"
        }
      ],
      "ban_status": "ALLOWED",
      "classifications": [],
      "creation_time": "2010-05-06T12:23:34.321Z",
      "email": "alice@example.com",
      "has_accounts": true,
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "kyc_exempt": true,
      "kyc_last_run": "2010-05-06T12:23:34.321Z",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "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",
      "related_customers": [
        {
          "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "relationship_role": "CUSTODIAN"
        }
      ],
      "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",
      "tenant": "abcdef_ghijkl",
      "dob": "2000-01-01",
      "first_name": "Jane",
      "last_name": "Smith"
    }
  ],
  "next_page_token": "a8937a0d"
}

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

GET

customers

List Customers

curl --request GET \
  --url https://api-sandbox.synctera.com/v0/customers \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api-sandbox.synctera.com/v0/customers', 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/customers",
  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-sandbox.synctera.com/v0/customers"

	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-sandbox.synctera.com/v0/customers")

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

{
  "customers": [
    {
      "vendor_info": {
        "vendor_data": {
          "loanpro": {
            "customer_id": 12345
          }
        },
        "vendor_type": "LOANPRO"
      },
      "addresses": [
        {
          "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"
        }
      ],
      "ban_status": "ALLOWED",
      "classifications": [],
      "creation_time": "2010-05-06T12:23:34.321Z",
      "email": "alice@example.com",
      "has_accounts": true,
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "kyc_exempt": true,
      "kyc_last_run": "2010-05-06T12:23:34.321Z",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "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",
      "related_customers": [
        {
          "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
          "relationship_role": "CUSTODIAN"
        }
      ],
      "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",
      "tenant": "abcdef_ghijkl",
      "dob": "2000-01-01",
      "first_name": "Jane",
      "last_name": "Smith"
    }
  ],
  "next_page_token": "a8937a0d"
}

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

Query Parameters

has_accounts

boolean

Filter on resources that have an account(s)

ssn_last_4

string

Only return resources where the last 4 characters of the SSN match the specified value.

Required string length: 4

Example:

"6789"

last_name

string

Only return resources where the last_name field matches the specified string. Any * characters in the string are wildcards, and match any characters.

Example:

"Smith"

string

Only return resources where the email field matches the specified string. Any * characters in the string are wildcards, and match any characters.

Example:

"john.doe@example.com"

first_name

string

Only return resources where the first_name or chosen_name field matches the specified string. Any * characters in the string are wildcards, and match any characters.

Example:

"Alice"

classifications

enum<string>[]

read-only

Specifies the classification of a party for banks. It can contain multiple values. 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:

AUTHORIZED_USER,

BANK_CUSTOMER,

INACTIVE_BANK_CUSTOMER,

PROSPECT

phone_number

string

Only return resources where the phone_number field matches the specified string. Phone numbers use the E.164 format e.g. +19178675309. Any * characters in the string are wildcards, and match any characters.

Example:

"+12065550100"

page_token

string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

string<uuid>[]

Unique resource identifier

limit

integer

default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1

Example:

100

sort_by

enum<string>[]

Specifies the sort order for the returned customers.

Available options:

creation_time:asc,

creation_time:desc,

first_name:asc,

first_name:desc,

last_name:asc,

last_name:desc,

last_updated_time:asc,

last_updated_time:desc

status

enum<string>

Only return resources where with the specified status.

Available options:

ACTIVE,

DECEASED,

DENIED,

DORMANT,

ESCHEAT,

FROZEN,

INACTIVE,

PROSPECT,

SANCTION

Example:

"ACTIVE"

Response

List of customers

customers

(Prospect · object | Customer · object)[]

required

Array of Customers

Details of a prospect

Prospect
Customer

Show child attributes

next_page_token

string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"

⌘I

Synctera API

Customers

Accounts

Cards

Money Movement

Transactions

Platform

Simulations

Deprecated

List Customers

Authorizations

Query Parameters

Response