Update Customer
curl --request PUT \
--url https://api-sandbox.synctera.com/v0/customers/{customer_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ban_status": "ALLOWED",
"email": "alice@example.com",
"metadata": {},
"middle_name": "Anne",
"note": "<string>",
"phone_number": "+14374570680",
"related_customers": [
{
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"relationship_role": "CUSTODIAN"
}
],
"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"
}
'import requests
url = "https://api-sandbox.synctera.com/v0/customers/{customer_id}"
payload = {
"ban_status": "ALLOWED",
"email": "alice@example.com",
"metadata": {},
"middle_name": "Anne",
"note": "<string>",
"phone_number": "+14374570680",
"related_customers": [
{
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"relationship_role": "CUSTODIAN"
}
],
"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"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ban_status: 'ALLOWED',
email: 'alice@example.com',
metadata: {},
middle_name: 'Anne',
note: '<string>',
phone_number: '+14374570680',
related_customers: [{id: '7d943c51-e4ff-4e57-9558-08cab6b963c7', relationship_role: 'CUSTODIAN'}],
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'
})
};
fetch('https://api-sandbox.synctera.com/v0/customers/{customer_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/customers/{customer_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'ban_status' => 'ALLOWED',
'email' => 'alice@example.com',
'metadata' => [
],
'middle_name' => 'Anne',
'note' => '<string>',
'phone_number' => '+14374570680',
'related_customers' => [
[
'id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'relationship_role' => 'CUSTODIAN'
]
],
'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'
]),
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/customers/{customer_id}"
payload := strings.NewReader("{\n \"ban_status\": \"ALLOWED\",\n \"email\": \"alice@example.com\",\n \"metadata\": {},\n \"middle_name\": \"Anne\",\n \"note\": \"<string>\",\n \"phone_number\": \"+14374570680\",\n \"related_customers\": [\n {\n \"id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"relationship_role\": \"CUSTODIAN\"\n }\n ],\n \"spend_control_ids\": [\n \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n ],\n \"ssn\": \"123-45-6789\",\n \"tenant\": \"abcdef_ghijkl\",\n \"dob\": \"2000-01-01\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api-sandbox.synctera.com/v0/customers/{customer_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ban_status\": \"ALLOWED\",\n \"email\": \"alice@example.com\",\n \"metadata\": {},\n \"middle_name\": \"Anne\",\n \"note\": \"<string>\",\n \"phone_number\": \"+14374570680\",\n \"related_customers\": [\n {\n \"id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"relationship_role\": \"CUSTODIAN\"\n }\n ],\n \"spend_control_ids\": [\n \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n ],\n \"ssn\": \"123-45-6789\",\n \"tenant\": \"abcdef_ghijkl\",\n \"dob\": \"2000-01-01\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/customers/{customer_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ban_status\": \"ALLOWED\",\n \"email\": \"alice@example.com\",\n \"metadata\": {},\n \"middle_name\": \"Anne\",\n \"note\": \"<string>\",\n \"phone_number\": \"+14374570680\",\n \"related_customers\": [\n {\n \"id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"relationship_role\": \"CUSTODIAN\"\n }\n ],\n \"spend_control_ids\": [\n \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n ],\n \"ssn\": \"123-45-6789\",\n \"tenant\": \"abcdef_ghijkl\",\n \"dob\": \"2000-01-01\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\"\n}"
response = http.request(request)
puts response.read_body{
"status": "ACTIVE",
"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": [
"AUTHORIZED_USER"
],
"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",
"kyc_status": "ACCEPTED",
"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",
"ssn_source": "MANUAL",
"tenant": "abcdef_ghijkl",
"dob": "2000-01-01",
"first_name": "Jane",
"last_name": "Smith"
}{
"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"
}Customers
Update Customer
Update customer based on ID Note that if no shipping_address attribute is provided in the request, the shipping_address will be set to a copy of the legal_address.
PUT
/
customers
/
{customer_id}
Update Customer
curl --request PUT \
--url https://api-sandbox.synctera.com/v0/customers/{customer_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ban_status": "ALLOWED",
"email": "alice@example.com",
"metadata": {},
"middle_name": "Anne",
"note": "<string>",
"phone_number": "+14374570680",
"related_customers": [
{
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"relationship_role": "CUSTODIAN"
}
],
"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"
}
'import requests
url = "https://api-sandbox.synctera.com/v0/customers/{customer_id}"
payload = {
"ban_status": "ALLOWED",
"email": "alice@example.com",
"metadata": {},
"middle_name": "Anne",
"note": "<string>",
"phone_number": "+14374570680",
"related_customers": [
{
"id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
"relationship_role": "CUSTODIAN"
}
],
"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"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ban_status: 'ALLOWED',
email: 'alice@example.com',
metadata: {},
middle_name: 'Anne',
note: '<string>',
phone_number: '+14374570680',
related_customers: [{id: '7d943c51-e4ff-4e57-9558-08cab6b963c7', relationship_role: 'CUSTODIAN'}],
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'
})
};
fetch('https://api-sandbox.synctera.com/v0/customers/{customer_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/customers/{customer_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'ban_status' => 'ALLOWED',
'email' => 'alice@example.com',
'metadata' => [
],
'middle_name' => 'Anne',
'note' => '<string>',
'phone_number' => '+14374570680',
'related_customers' => [
[
'id' => '7d943c51-e4ff-4e57-9558-08cab6b963c7',
'relationship_role' => 'CUSTODIAN'
]
],
'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'
]),
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/customers/{customer_id}"
payload := strings.NewReader("{\n \"ban_status\": \"ALLOWED\",\n \"email\": \"alice@example.com\",\n \"metadata\": {},\n \"middle_name\": \"Anne\",\n \"note\": \"<string>\",\n \"phone_number\": \"+14374570680\",\n \"related_customers\": [\n {\n \"id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"relationship_role\": \"CUSTODIAN\"\n }\n ],\n \"spend_control_ids\": [\n \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n ],\n \"ssn\": \"123-45-6789\",\n \"tenant\": \"abcdef_ghijkl\",\n \"dob\": \"2000-01-01\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api-sandbox.synctera.com/v0/customers/{customer_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ban_status\": \"ALLOWED\",\n \"email\": \"alice@example.com\",\n \"metadata\": {},\n \"middle_name\": \"Anne\",\n \"note\": \"<string>\",\n \"phone_number\": \"+14374570680\",\n \"related_customers\": [\n {\n \"id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"relationship_role\": \"CUSTODIAN\"\n }\n ],\n \"spend_control_ids\": [\n \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n ],\n \"ssn\": \"123-45-6789\",\n \"tenant\": \"abcdef_ghijkl\",\n \"dob\": \"2000-01-01\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.synctera.com/v0/customers/{customer_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ban_status\": \"ALLOWED\",\n \"email\": \"alice@example.com\",\n \"metadata\": {},\n \"middle_name\": \"Anne\",\n \"note\": \"<string>\",\n \"phone_number\": \"+14374570680\",\n \"related_customers\": [\n {\n \"id\": \"7d943c51-e4ff-4e57-9558-08cab6b963c7\",\n \"relationship_role\": \"CUSTODIAN\"\n }\n ],\n \"spend_control_ids\": [\n \"7d943c51-e4ff-4e57-9558-08cab6b963c7\"\n ],\n \"ssn\": \"123-45-6789\",\n \"tenant\": \"abcdef_ghijkl\",\n \"dob\": \"2000-01-01\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Smith\"\n}"
response = http.request(request)
puts response.read_body{
"status": "ACTIVE",
"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": [
"AUTHORIZED_USER"
],
"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",
"kyc_status": "ACCEPTED",
"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",
"ssn_source": "MANUAL",
"tenant": "abcdef_ghijkl",
"dob": "2000-01-01",
"first_name": "Jane",
"last_name": "Smith"
}{
"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.
Path Parameters
The customer's unique identifier
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Body
application/json
Customer to be updated
- Customer
- Customer
Details of a customer
Customer's status
Available options:
ACTIVE, DECEASED, DENIED, DORMANT, ESCHEAT, FROZEN, INACTIVE, PROSPECT, SANCTION (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.
Available options:
ALLOWED, BANNED, SUSPENDED Example:
"ALLOWED"
Customer's email
Example:
"alice@example.com"
Legal address
Show child attributes
Show child attributes
User-supplied metadata. Do not use to store PII.
Customer's middle name
Example:
"Anne"
Add an optional note when creating or updating a customer. A note is required when updating a customers's ban_status between SUSPENDED and ALLOWED.
Customer'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"
Customer's relationships with other accounts eg. guardian. This property is no longer supported. Setting it will return an error.
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
Maximum array length:
100Customer's full tax ID eg SSN formatted with hyphens. This optional parameter is required when running KYC on a customer. Input must match the pattern ^\d{3}-\d{2}-\d{4}$. The response contains the last 4 digits only (e.g. 6789).
Example:
"123-45-6789"
The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
Example:
"abcdef_ghijkl"
Customer'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"
Customer's first name
Example:
"Jane"
Customer's last name
Example:
"Smith"
Response
Updated customer
- Prospect
- Customer
Details of a prospect
Customer's status
Available options:
ACTIVE, DECEASED, DENIED, DORMANT, ESCHEAT, FROZEN, INACTIVE, PROSPECT, SANCTION Vendor information for external account management systems
Show child attributes
Show child attributes
All of the customer's addresses
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.
Available options:
ALLOWED, BANNED, SUSPENDED Example:
"ALLOWED"
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 The date and time the resource was created.
Example:
"2010-05-06T12:23:34.321Z"
Customer's email
Example:
"alice@example.com"
This flag indicates whether the person or business has accounts.
Customer unique identifier
Example:
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
Customer's KYC exemption
Date and time KYC was last run on the customer
Example:
"2010-05-06T12:23:34.321Z"
Customer's KYC status
Available options:
ACCEPTED, PENDING, PROVIDER_FAILURE, PROVISIONAL, REJECTED, REVIEW, UNVERIFIED The date and time the resource was last updated.
Example:
"2010-05-06T12:23:34.321Z"
Legal address
Show child attributes
Show child attributes
User-supplied metadata. Do not use to store PII.
Customer's middle name
Example:
"Anne"
Customer'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"
Customer's relationships with other accounts eg. guardian. This property is no longer supported. Setting it will return an error.
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
Maximum array length:
100Customer's full tax ID eg SSN formatted with hyphens. This optional parameter is required when running KYC on a customer. Input must match the pattern ^\d{3}-\d{2}-\d{4}$. The response contains the last 4 digits only (e.g. 6789).
Example:
"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.
Available options:
MANUAL, PREFILL The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
Example:
"abcdef_ghijkl"
Customer's date of birth in RFC 3339 full-date format (YYYY-MM-DD)
Example:
"2000-01-01"
Customer's first name
Example:
"Jane"
Customer's last name
Example:
"Smith"
Was this page helpful?