Update a Customer by ID
curl --request PATCH \
--url https://api.spherepay.co/v2/customer/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"address": {
"city": "Chicago",
"country": "USA",
"line1": "233 South Wacker Drive",
"line2": "Suite 4700",
"postalCode": "60606",
"state": "IL"
},
"addresses": [
{
"address": {
"city": "Chicago",
"country": "USA",
"line1": "233 South Wacker Drive",
"line2": "Suite 4700",
"postalCode": "60606",
"state": "IL"
},
"type": "residential"
}
],
"enabledVerificationProfiles": [
"a",
"c"
],
"ipAddress": "203.0.113.4",
"meta": {
"key": "value"
},
"personalExpectedActivity": {
"expectedCounterpartyTypes": [
"domestic_individual",
"foreign_business"
],
"expectedGeographies": [
"MEX",
"USA"
],
"expectedMonthlyTransactionCount": "16_50",
"transactionFrequency": "monthly"
},
"personalInformation": {
"accountPurpose": "receive_salary",
"accountPurposeDescription": "<string>",
"actingAsIntermediary": false,
"countryOfBirth": "USA",
"employmentStatus": "employed",
"expectedMonthlyPayments": "5000_9999",
"gender": "male",
"middleName": "James",
"nationality": "USA",
"occupationSocCode": "151252",
"residencyCountry": "USA",
"sourceOfFunds": "salary",
"stateOfBirth": "JAL",
"taxIdentificationNumber": "123456789",
"taxIdentificationNumberCountry": "USA",
"taxIdentificationNumberDescription": "<string>",
"taxIdentificationNumberType": "ssn"
}
}
'import requests
url = "https://api.spherepay.co/v2/customer/{id}"
payload = {
"address": {
"city": "Chicago",
"country": "USA",
"line1": "233 South Wacker Drive",
"line2": "Suite 4700",
"postalCode": "60606",
"state": "IL"
},
"addresses": [
{
"address": {
"city": "Chicago",
"country": "USA",
"line1": "233 South Wacker Drive",
"line2": "Suite 4700",
"postalCode": "60606",
"state": "IL"
},
"type": "residential"
}
],
"enabledVerificationProfiles": ["a", "c"],
"ipAddress": "203.0.113.4",
"meta": { "key": "value" },
"personalExpectedActivity": {
"expectedCounterpartyTypes": ["domestic_individual", "foreign_business"],
"expectedGeographies": ["MEX", "USA"],
"expectedMonthlyTransactionCount": "16_50",
"transactionFrequency": "monthly"
},
"personalInformation": {
"accountPurpose": "receive_salary",
"accountPurposeDescription": "<string>",
"actingAsIntermediary": False,
"countryOfBirth": "USA",
"employmentStatus": "employed",
"expectedMonthlyPayments": "5000_9999",
"gender": "male",
"middleName": "James",
"nationality": "USA",
"occupationSocCode": "151252",
"residencyCountry": "USA",
"sourceOfFunds": "salary",
"stateOfBirth": "JAL",
"taxIdentificationNumber": "123456789",
"taxIdentificationNumberCountry": "USA",
"taxIdentificationNumberDescription": "<string>",
"taxIdentificationNumberType": "ssn"
}
}
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({
address: {
city: 'Chicago',
country: 'USA',
line1: '233 South Wacker Drive',
line2: 'Suite 4700',
postalCode: '60606',
state: 'IL'
},
addresses: [
{
address: {
city: 'Chicago',
country: 'USA',
line1: '233 South Wacker Drive',
line2: 'Suite 4700',
postalCode: '60606',
state: 'IL'
},
type: 'residential'
}
],
enabledVerificationProfiles: ['a', 'c'],
ipAddress: '203.0.113.4',
meta: {key: 'value'},
personalExpectedActivity: {
expectedCounterpartyTypes: ['domestic_individual', 'foreign_business'],
expectedGeographies: ['MEX', 'USA'],
expectedMonthlyTransactionCount: '16_50',
transactionFrequency: 'monthly'
},
personalInformation: {
accountPurpose: 'receive_salary',
accountPurposeDescription: '<string>',
actingAsIntermediary: false,
countryOfBirth: 'USA',
employmentStatus: 'employed',
expectedMonthlyPayments: '5000_9999',
gender: 'male',
middleName: 'James',
nationality: 'USA',
occupationSocCode: '151252',
residencyCountry: 'USA',
sourceOfFunds: 'salary',
stateOfBirth: 'JAL',
taxIdentificationNumber: '123456789',
taxIdentificationNumberCountry: 'USA',
taxIdentificationNumberDescription: '<string>',
taxIdentificationNumberType: 'ssn'
}
})
};
fetch('https://api.spherepay.co/v2/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.spherepay.co/v2/customer/{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([
'address' => [
'city' => 'Chicago',
'country' => 'USA',
'line1' => '233 South Wacker Drive',
'line2' => 'Suite 4700',
'postalCode' => '60606',
'state' => 'IL'
],
'addresses' => [
[
'address' => [
'city' => 'Chicago',
'country' => 'USA',
'line1' => '233 South Wacker Drive',
'line2' => 'Suite 4700',
'postalCode' => '60606',
'state' => 'IL'
],
'type' => 'residential'
]
],
'enabledVerificationProfiles' => [
'a',
'c'
],
'ipAddress' => '203.0.113.4',
'meta' => [
'key' => 'value'
],
'personalExpectedActivity' => [
'expectedCounterpartyTypes' => [
'domestic_individual',
'foreign_business'
],
'expectedGeographies' => [
'MEX',
'USA'
],
'expectedMonthlyTransactionCount' => '16_50',
'transactionFrequency' => 'monthly'
],
'personalInformation' => [
'accountPurpose' => 'receive_salary',
'accountPurposeDescription' => '<string>',
'actingAsIntermediary' => false,
'countryOfBirth' => 'USA',
'employmentStatus' => 'employed',
'expectedMonthlyPayments' => '5000_9999',
'gender' => 'male',
'middleName' => 'James',
'nationality' => 'USA',
'occupationSocCode' => '151252',
'residencyCountry' => 'USA',
'sourceOfFunds' => 'salary',
'stateOfBirth' => 'JAL',
'taxIdentificationNumber' => '123456789',
'taxIdentificationNumberCountry' => 'USA',
'taxIdentificationNumberDescription' => '<string>',
'taxIdentificationNumberType' => 'ssn'
]
]),
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.spherepay.co/v2/customer/{id}"
payload := strings.NewReader("{\n \"address\": {\n \"city\": \"Chicago\",\n \"country\": \"USA\",\n \"line1\": \"233 South Wacker Drive\",\n \"line2\": \"Suite 4700\",\n \"postalCode\": \"60606\",\n \"state\": \"IL\"\n },\n \"addresses\": [\n {\n \"address\": {\n \"city\": \"Chicago\",\n \"country\": \"USA\",\n \"line1\": \"233 South Wacker Drive\",\n \"line2\": \"Suite 4700\",\n \"postalCode\": \"60606\",\n \"state\": \"IL\"\n },\n \"type\": \"residential\"\n }\n ],\n \"enabledVerificationProfiles\": [\n \"a\",\n \"c\"\n ],\n \"ipAddress\": \"203.0.113.4\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"personalExpectedActivity\": {\n \"expectedCounterpartyTypes\": [\n \"domestic_individual\",\n \"foreign_business\"\n ],\n \"expectedGeographies\": [\n \"MEX\",\n \"USA\"\n ],\n \"expectedMonthlyTransactionCount\": \"16_50\",\n \"transactionFrequency\": \"monthly\"\n },\n \"personalInformation\": {\n \"accountPurpose\": \"receive_salary\",\n \"accountPurposeDescription\": \"<string>\",\n \"actingAsIntermediary\": false,\n \"countryOfBirth\": \"USA\",\n \"employmentStatus\": \"employed\",\n \"expectedMonthlyPayments\": \"5000_9999\",\n \"gender\": \"male\",\n \"middleName\": \"James\",\n \"nationality\": \"USA\",\n \"occupationSocCode\": \"151252\",\n \"residencyCountry\": \"USA\",\n \"sourceOfFunds\": \"salary\",\n \"stateOfBirth\": \"JAL\",\n \"taxIdentificationNumber\": \"123456789\",\n \"taxIdentificationNumberCountry\": \"USA\",\n \"taxIdentificationNumberDescription\": \"<string>\",\n \"taxIdentificationNumberType\": \"ssn\"\n }\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.spherepay.co/v2/customer/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"city\": \"Chicago\",\n \"country\": \"USA\",\n \"line1\": \"233 South Wacker Drive\",\n \"line2\": \"Suite 4700\",\n \"postalCode\": \"60606\",\n \"state\": \"IL\"\n },\n \"addresses\": [\n {\n \"address\": {\n \"city\": \"Chicago\",\n \"country\": \"USA\",\n \"line1\": \"233 South Wacker Drive\",\n \"line2\": \"Suite 4700\",\n \"postalCode\": \"60606\",\n \"state\": \"IL\"\n },\n \"type\": \"residential\"\n }\n ],\n \"enabledVerificationProfiles\": [\n \"a\",\n \"c\"\n ],\n \"ipAddress\": \"203.0.113.4\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"personalExpectedActivity\": {\n \"expectedCounterpartyTypes\": [\n \"domestic_individual\",\n \"foreign_business\"\n ],\n \"expectedGeographies\": [\n \"MEX\",\n \"USA\"\n ],\n \"expectedMonthlyTransactionCount\": \"16_50\",\n \"transactionFrequency\": \"monthly\"\n },\n \"personalInformation\": {\n \"accountPurpose\": \"receive_salary\",\n \"accountPurposeDescription\": \"<string>\",\n \"actingAsIntermediary\": false,\n \"countryOfBirth\": \"USA\",\n \"employmentStatus\": \"employed\",\n \"expectedMonthlyPayments\": \"5000_9999\",\n \"gender\": \"male\",\n \"middleName\": \"James\",\n \"nationality\": \"USA\",\n \"occupationSocCode\": \"151252\",\n \"residencyCountry\": \"USA\",\n \"sourceOfFunds\": \"salary\",\n \"stateOfBirth\": \"JAL\",\n \"taxIdentificationNumber\": \"123456789\",\n \"taxIdentificationNumberCountry\": \"USA\",\n \"taxIdentificationNumberDescription\": \"<string>\",\n \"taxIdentificationNumberType\": \"ssn\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spherepay.co/v2/customer/{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 \"address\": {\n \"city\": \"Chicago\",\n \"country\": \"USA\",\n \"line1\": \"233 South Wacker Drive\",\n \"line2\": \"Suite 4700\",\n \"postalCode\": \"60606\",\n \"state\": \"IL\"\n },\n \"addresses\": [\n {\n \"address\": {\n \"city\": \"Chicago\",\n \"country\": \"USA\",\n \"line1\": \"233 South Wacker Drive\",\n \"line2\": \"Suite 4700\",\n \"postalCode\": \"60606\",\n \"state\": \"IL\"\n },\n \"type\": \"residential\"\n }\n ],\n \"enabledVerificationProfiles\": [\n \"a\",\n \"c\"\n ],\n \"ipAddress\": \"203.0.113.4\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"personalExpectedActivity\": {\n \"expectedCounterpartyTypes\": [\n \"domestic_individual\",\n \"foreign_business\"\n ],\n \"expectedGeographies\": [\n \"MEX\",\n \"USA\"\n ],\n \"expectedMonthlyTransactionCount\": \"16_50\",\n \"transactionFrequency\": \"monthly\"\n },\n \"personalInformation\": {\n \"accountPurpose\": \"receive_salary\",\n \"accountPurposeDescription\": \"<string>\",\n \"actingAsIntermediary\": false,\n \"countryOfBirth\": \"USA\",\n \"employmentStatus\": \"employed\",\n \"expectedMonthlyPayments\": \"5000_9999\",\n \"gender\": \"male\",\n \"middleName\": \"James\",\n \"nationality\": \"USA\",\n \"occupationSocCode\": \"151252\",\n \"residencyCountry\": \"USA\",\n \"sourceOfFunds\": \"salary\",\n \"stateOfBirth\": \"JAL\",\n \"taxIdentificationNumber\": \"123456789\",\n \"taxIdentificationNumberCountry\": \"USA\",\n \"taxIdentificationNumberDescription\": \"<string>\",\n \"taxIdentificationNumberType\": \"ssn\"\n }\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2026-03-09T20:46:31.305Z",
"enabledVerificationProfiles": [
"a",
"c"
],
"id": "customer_f31121c389624d3697cbf3ea8830b7a4",
"tosStatus": "incomplete",
"type": "individual",
"updatedAt": "2026-03-09T20:46:31.305Z",
"verificationProfiles": [
{
"criteria": {
"complete": [
"email_address",
"phone_number",
"residential_address",
"tax_identification_number"
],
"errors": [],
"pending": [],
"required": [
"identity_document",
"liveness_report_document"
]
},
"name": "kyc_profile_a",
"status": "incomplete"
}
],
"dateOfBirth": "1990-01-15",
"email": "jane.smith@example.com",
"firstName": "Jane",
"lastName": "Smith",
"meta": {},
"personalInformation": {
"accountPurpose": "<string>",
"accountPurposeDescription": "<string>",
"actingAsIntermediary": false,
"countryOfBirth": "USA",
"employmentStatus": "<string>",
"expectedMonthlyPayments": "<string>",
"gender": "<string>",
"middleName": "James",
"nationality": "USA",
"occupationSocCode": "151252",
"residencyCountry": "USA",
"sourceOfFunds": "<string>",
"stateOfBirth": "JAL",
"taxIdentificationNumberCountry": "USA",
"taxIdentificationNumberDescription": "<string>",
"taxIdentificationNumberType": "ssn"
},
"phone": "+14155550123",
"statusDetails": {
"message": "Please re-upload a clear photo of the front and back of the director's ID and correct the tax ID number.",
"reasons": [
{
"externalReason": "Cannot validate ID — upload a photo of the ID that is clear",
"reasonCode": "poor_image_quality",
"verificationProfiles": [
"kyb_profile_a"
]
},
{
"externalReason": "The tax identification number is not in a valid format for the selected country and ID type.",
"reasonCode": "invalid_tax_identification_number",
"verificationProfiles": [
"kyb_profile_a"
]
}
],
"updatedAt": "2026-07-16T21:04:00Z"
}
}{
"code": "address/invalid",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Invalid request parameters",
"status": 400
}{
"code": "resource/not-found",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Resource not found",
"status": 404
}{
"code": "customer/onboarding-v3-managed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "This customer cannot be used with this route.",
"status": 409
}{
"code": "validation/failed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Validation failed",
"errors": [
{
"detail": "Invalid email format",
"pointer": "/email"
},
{
"detail": "Name is required",
"pointer": "/name"
}
],
"status": 422
}Clientes
Actualizar Dirección, Teléfono o Correo del Cliente
Update a customer by ID. Individual and business customers can be updated during onboarding. A field is locked once a verification profile that is pending, approved or terminally rejected has completed the criterion the field supplies; locked fields return 400 with a pointer per field. Business customers may add verification profiles and supply the fields those profiles add.
Update a Customer by ID
curl --request PATCH \
--url https://api.spherepay.co/v2/customer/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"address": {
"city": "Chicago",
"country": "USA",
"line1": "233 South Wacker Drive",
"line2": "Suite 4700",
"postalCode": "60606",
"state": "IL"
},
"addresses": [
{
"address": {
"city": "Chicago",
"country": "USA",
"line1": "233 South Wacker Drive",
"line2": "Suite 4700",
"postalCode": "60606",
"state": "IL"
},
"type": "residential"
}
],
"enabledVerificationProfiles": [
"a",
"c"
],
"ipAddress": "203.0.113.4",
"meta": {
"key": "value"
},
"personalExpectedActivity": {
"expectedCounterpartyTypes": [
"domestic_individual",
"foreign_business"
],
"expectedGeographies": [
"MEX",
"USA"
],
"expectedMonthlyTransactionCount": "16_50",
"transactionFrequency": "monthly"
},
"personalInformation": {
"accountPurpose": "receive_salary",
"accountPurposeDescription": "<string>",
"actingAsIntermediary": false,
"countryOfBirth": "USA",
"employmentStatus": "employed",
"expectedMonthlyPayments": "5000_9999",
"gender": "male",
"middleName": "James",
"nationality": "USA",
"occupationSocCode": "151252",
"residencyCountry": "USA",
"sourceOfFunds": "salary",
"stateOfBirth": "JAL",
"taxIdentificationNumber": "123456789",
"taxIdentificationNumberCountry": "USA",
"taxIdentificationNumberDescription": "<string>",
"taxIdentificationNumberType": "ssn"
}
}
'import requests
url = "https://api.spherepay.co/v2/customer/{id}"
payload = {
"address": {
"city": "Chicago",
"country": "USA",
"line1": "233 South Wacker Drive",
"line2": "Suite 4700",
"postalCode": "60606",
"state": "IL"
},
"addresses": [
{
"address": {
"city": "Chicago",
"country": "USA",
"line1": "233 South Wacker Drive",
"line2": "Suite 4700",
"postalCode": "60606",
"state": "IL"
},
"type": "residential"
}
],
"enabledVerificationProfiles": ["a", "c"],
"ipAddress": "203.0.113.4",
"meta": { "key": "value" },
"personalExpectedActivity": {
"expectedCounterpartyTypes": ["domestic_individual", "foreign_business"],
"expectedGeographies": ["MEX", "USA"],
"expectedMonthlyTransactionCount": "16_50",
"transactionFrequency": "monthly"
},
"personalInformation": {
"accountPurpose": "receive_salary",
"accountPurposeDescription": "<string>",
"actingAsIntermediary": False,
"countryOfBirth": "USA",
"employmentStatus": "employed",
"expectedMonthlyPayments": "5000_9999",
"gender": "male",
"middleName": "James",
"nationality": "USA",
"occupationSocCode": "151252",
"residencyCountry": "USA",
"sourceOfFunds": "salary",
"stateOfBirth": "JAL",
"taxIdentificationNumber": "123456789",
"taxIdentificationNumberCountry": "USA",
"taxIdentificationNumberDescription": "<string>",
"taxIdentificationNumberType": "ssn"
}
}
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({
address: {
city: 'Chicago',
country: 'USA',
line1: '233 South Wacker Drive',
line2: 'Suite 4700',
postalCode: '60606',
state: 'IL'
},
addresses: [
{
address: {
city: 'Chicago',
country: 'USA',
line1: '233 South Wacker Drive',
line2: 'Suite 4700',
postalCode: '60606',
state: 'IL'
},
type: 'residential'
}
],
enabledVerificationProfiles: ['a', 'c'],
ipAddress: '203.0.113.4',
meta: {key: 'value'},
personalExpectedActivity: {
expectedCounterpartyTypes: ['domestic_individual', 'foreign_business'],
expectedGeographies: ['MEX', 'USA'],
expectedMonthlyTransactionCount: '16_50',
transactionFrequency: 'monthly'
},
personalInformation: {
accountPurpose: 'receive_salary',
accountPurposeDescription: '<string>',
actingAsIntermediary: false,
countryOfBirth: 'USA',
employmentStatus: 'employed',
expectedMonthlyPayments: '5000_9999',
gender: 'male',
middleName: 'James',
nationality: 'USA',
occupationSocCode: '151252',
residencyCountry: 'USA',
sourceOfFunds: 'salary',
stateOfBirth: 'JAL',
taxIdentificationNumber: '123456789',
taxIdentificationNumberCountry: 'USA',
taxIdentificationNumberDescription: '<string>',
taxIdentificationNumberType: 'ssn'
}
})
};
fetch('https://api.spherepay.co/v2/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.spherepay.co/v2/customer/{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([
'address' => [
'city' => 'Chicago',
'country' => 'USA',
'line1' => '233 South Wacker Drive',
'line2' => 'Suite 4700',
'postalCode' => '60606',
'state' => 'IL'
],
'addresses' => [
[
'address' => [
'city' => 'Chicago',
'country' => 'USA',
'line1' => '233 South Wacker Drive',
'line2' => 'Suite 4700',
'postalCode' => '60606',
'state' => 'IL'
],
'type' => 'residential'
]
],
'enabledVerificationProfiles' => [
'a',
'c'
],
'ipAddress' => '203.0.113.4',
'meta' => [
'key' => 'value'
],
'personalExpectedActivity' => [
'expectedCounterpartyTypes' => [
'domestic_individual',
'foreign_business'
],
'expectedGeographies' => [
'MEX',
'USA'
],
'expectedMonthlyTransactionCount' => '16_50',
'transactionFrequency' => 'monthly'
],
'personalInformation' => [
'accountPurpose' => 'receive_salary',
'accountPurposeDescription' => '<string>',
'actingAsIntermediary' => false,
'countryOfBirth' => 'USA',
'employmentStatus' => 'employed',
'expectedMonthlyPayments' => '5000_9999',
'gender' => 'male',
'middleName' => 'James',
'nationality' => 'USA',
'occupationSocCode' => '151252',
'residencyCountry' => 'USA',
'sourceOfFunds' => 'salary',
'stateOfBirth' => 'JAL',
'taxIdentificationNumber' => '123456789',
'taxIdentificationNumberCountry' => 'USA',
'taxIdentificationNumberDescription' => '<string>',
'taxIdentificationNumberType' => 'ssn'
]
]),
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.spherepay.co/v2/customer/{id}"
payload := strings.NewReader("{\n \"address\": {\n \"city\": \"Chicago\",\n \"country\": \"USA\",\n \"line1\": \"233 South Wacker Drive\",\n \"line2\": \"Suite 4700\",\n \"postalCode\": \"60606\",\n \"state\": \"IL\"\n },\n \"addresses\": [\n {\n \"address\": {\n \"city\": \"Chicago\",\n \"country\": \"USA\",\n \"line1\": \"233 South Wacker Drive\",\n \"line2\": \"Suite 4700\",\n \"postalCode\": \"60606\",\n \"state\": \"IL\"\n },\n \"type\": \"residential\"\n }\n ],\n \"enabledVerificationProfiles\": [\n \"a\",\n \"c\"\n ],\n \"ipAddress\": \"203.0.113.4\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"personalExpectedActivity\": {\n \"expectedCounterpartyTypes\": [\n \"domestic_individual\",\n \"foreign_business\"\n ],\n \"expectedGeographies\": [\n \"MEX\",\n \"USA\"\n ],\n \"expectedMonthlyTransactionCount\": \"16_50\",\n \"transactionFrequency\": \"monthly\"\n },\n \"personalInformation\": {\n \"accountPurpose\": \"receive_salary\",\n \"accountPurposeDescription\": \"<string>\",\n \"actingAsIntermediary\": false,\n \"countryOfBirth\": \"USA\",\n \"employmentStatus\": \"employed\",\n \"expectedMonthlyPayments\": \"5000_9999\",\n \"gender\": \"male\",\n \"middleName\": \"James\",\n \"nationality\": \"USA\",\n \"occupationSocCode\": \"151252\",\n \"residencyCountry\": \"USA\",\n \"sourceOfFunds\": \"salary\",\n \"stateOfBirth\": \"JAL\",\n \"taxIdentificationNumber\": \"123456789\",\n \"taxIdentificationNumberCountry\": \"USA\",\n \"taxIdentificationNumberDescription\": \"<string>\",\n \"taxIdentificationNumberType\": \"ssn\"\n }\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.spherepay.co/v2/customer/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"city\": \"Chicago\",\n \"country\": \"USA\",\n \"line1\": \"233 South Wacker Drive\",\n \"line2\": \"Suite 4700\",\n \"postalCode\": \"60606\",\n \"state\": \"IL\"\n },\n \"addresses\": [\n {\n \"address\": {\n \"city\": \"Chicago\",\n \"country\": \"USA\",\n \"line1\": \"233 South Wacker Drive\",\n \"line2\": \"Suite 4700\",\n \"postalCode\": \"60606\",\n \"state\": \"IL\"\n },\n \"type\": \"residential\"\n }\n ],\n \"enabledVerificationProfiles\": [\n \"a\",\n \"c\"\n ],\n \"ipAddress\": \"203.0.113.4\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"personalExpectedActivity\": {\n \"expectedCounterpartyTypes\": [\n \"domestic_individual\",\n \"foreign_business\"\n ],\n \"expectedGeographies\": [\n \"MEX\",\n \"USA\"\n ],\n \"expectedMonthlyTransactionCount\": \"16_50\",\n \"transactionFrequency\": \"monthly\"\n },\n \"personalInformation\": {\n \"accountPurpose\": \"receive_salary\",\n \"accountPurposeDescription\": \"<string>\",\n \"actingAsIntermediary\": false,\n \"countryOfBirth\": \"USA\",\n \"employmentStatus\": \"employed\",\n \"expectedMonthlyPayments\": \"5000_9999\",\n \"gender\": \"male\",\n \"middleName\": \"James\",\n \"nationality\": \"USA\",\n \"occupationSocCode\": \"151252\",\n \"residencyCountry\": \"USA\",\n \"sourceOfFunds\": \"salary\",\n \"stateOfBirth\": \"JAL\",\n \"taxIdentificationNumber\": \"123456789\",\n \"taxIdentificationNumberCountry\": \"USA\",\n \"taxIdentificationNumberDescription\": \"<string>\",\n \"taxIdentificationNumberType\": \"ssn\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.spherepay.co/v2/customer/{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 \"address\": {\n \"city\": \"Chicago\",\n \"country\": \"USA\",\n \"line1\": \"233 South Wacker Drive\",\n \"line2\": \"Suite 4700\",\n \"postalCode\": \"60606\",\n \"state\": \"IL\"\n },\n \"addresses\": [\n {\n \"address\": {\n \"city\": \"Chicago\",\n \"country\": \"USA\",\n \"line1\": \"233 South Wacker Drive\",\n \"line2\": \"Suite 4700\",\n \"postalCode\": \"60606\",\n \"state\": \"IL\"\n },\n \"type\": \"residential\"\n }\n ],\n \"enabledVerificationProfiles\": [\n \"a\",\n \"c\"\n ],\n \"ipAddress\": \"203.0.113.4\",\n \"meta\": {\n \"key\": \"value\"\n },\n \"personalExpectedActivity\": {\n \"expectedCounterpartyTypes\": [\n \"domestic_individual\",\n \"foreign_business\"\n ],\n \"expectedGeographies\": [\n \"MEX\",\n \"USA\"\n ],\n \"expectedMonthlyTransactionCount\": \"16_50\",\n \"transactionFrequency\": \"monthly\"\n },\n \"personalInformation\": {\n \"accountPurpose\": \"receive_salary\",\n \"accountPurposeDescription\": \"<string>\",\n \"actingAsIntermediary\": false,\n \"countryOfBirth\": \"USA\",\n \"employmentStatus\": \"employed\",\n \"expectedMonthlyPayments\": \"5000_9999\",\n \"gender\": \"male\",\n \"middleName\": \"James\",\n \"nationality\": \"USA\",\n \"occupationSocCode\": \"151252\",\n \"residencyCountry\": \"USA\",\n \"sourceOfFunds\": \"salary\",\n \"stateOfBirth\": \"JAL\",\n \"taxIdentificationNumber\": \"123456789\",\n \"taxIdentificationNumberCountry\": \"USA\",\n \"taxIdentificationNumberDescription\": \"<string>\",\n \"taxIdentificationNumberType\": \"ssn\"\n }\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2026-03-09T20:46:31.305Z",
"enabledVerificationProfiles": [
"a",
"c"
],
"id": "customer_f31121c389624d3697cbf3ea8830b7a4",
"tosStatus": "incomplete",
"type": "individual",
"updatedAt": "2026-03-09T20:46:31.305Z",
"verificationProfiles": [
{
"criteria": {
"complete": [
"email_address",
"phone_number",
"residential_address",
"tax_identification_number"
],
"errors": [],
"pending": [],
"required": [
"identity_document",
"liveness_report_document"
]
},
"name": "kyc_profile_a",
"status": "incomplete"
}
],
"dateOfBirth": "1990-01-15",
"email": "jane.smith@example.com",
"firstName": "Jane",
"lastName": "Smith",
"meta": {},
"personalInformation": {
"accountPurpose": "<string>",
"accountPurposeDescription": "<string>",
"actingAsIntermediary": false,
"countryOfBirth": "USA",
"employmentStatus": "<string>",
"expectedMonthlyPayments": "<string>",
"gender": "<string>",
"middleName": "James",
"nationality": "USA",
"occupationSocCode": "151252",
"residencyCountry": "USA",
"sourceOfFunds": "<string>",
"stateOfBirth": "JAL",
"taxIdentificationNumberCountry": "USA",
"taxIdentificationNumberDescription": "<string>",
"taxIdentificationNumberType": "ssn"
},
"phone": "+14155550123",
"statusDetails": {
"message": "Please re-upload a clear photo of the front and back of the director's ID and correct the tax ID number.",
"reasons": [
{
"externalReason": "Cannot validate ID — upload a photo of the ID that is clear",
"reasonCode": "poor_image_quality",
"verificationProfiles": [
"kyb_profile_a"
]
},
{
"externalReason": "The tax identification number is not in a valid format for the selected country and ID type.",
"reasonCode": "invalid_tax_identification_number",
"verificationProfiles": [
"kyb_profile_a"
]
}
],
"updatedAt": "2026-07-16T21:04:00Z"
}
}{
"code": "address/invalid",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Invalid request parameters",
"status": 400
}{
"code": "resource/not-found",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Resource not found",
"status": 404
}{
"code": "customer/onboarding-v3-managed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "This customer cannot be used with this route.",
"status": 409
}{
"code": "validation/failed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"detail": "Validation failed",
"errors": [
{
"detail": "Invalid email format",
"pointer": "/email"
},
{
"detail": "Name is required",
"pointer": "/name"
}
],
"status": 422
}Usa este endpoint para actualizar los campos mutables en un cliente individual existente. Puedes actualizar la dirección, información personal y metadatos del cliente en cualquier momento antes del envío de KYC. Una vez que una revisión de KYC ha sido enviada, los campos de identidad como nombre, fecha de nacimiento y número de identificación fiscal quedan bloqueados y no pueden cambiarse — solo los datos de contacto y metadatos siguen siendo editables.
Usa este endpoint para completar campos EEA+ (
accountPurpose, countryOfBirth, nationality) en clientes individuales existentes. La validación se ejecuta sobre el estado combinado del cliente — envía solo los campos que estás agregando o cambiando. Consulta Residentes EEA+.
Este endpoint actualmente soporta actualizaciones solo para clientes individuales. Los campos de cliente empresarial deben gestionarse a través del flujo de link KYC.
Autorizaciones
Cuerpo
application/json
- Individual Customer Update
- Business Customer Update
The customer's addresses. Individual customers support exactly one residential address. Provide either this field or the deprecated address field, not both.
Show child attributes
Show child attributes
Ejemplo:
[
{
"address": {
"city": "Chicago",
"country": "USA",
"line1": "233 South Wacker Drive",
"line2": "Suite 4700",
"postalCode": "60606",
"state": "IL"
},
"type": "residential"
}
]
Restricts which verification profile families this customer may onboard through. Must be a subset of the families enabled on your application; supplying one that is not enabled is rejected with a 422. Omit the field to inherit the application's setting.
Minimum array length:
1Opciones disponibles:
a, b, c, d Ejemplo:
["a", "c"]
Personal information including tax identification details for individual customers. When any tax identification field is provided, all tax identification fields (number, type, country) and address are required. Please refer to the Individual Verification Criteria for the full list of reference.
Show child attributes
Show child attributes
Respuesta
- Individual
- Business
Response containing information about an individual customer.
Which verification profile families this customer may onboard through. Set explicitly at creation — from the request when supplied, otherwise a snapshot of the application's families at that moment — and thereafter changed only by an explicit update, so it does not follow later changes to the application. Always a subset of the application's families. Distinct from verificationProfiles, which reports the evaluated profiles and their statuses.
Opciones disponibles:
a, b, c, d Ejemplo:
["a", "c"]
The evaluated verification profiles for this customer and their statuses — what the customer is being assessed against right now, as opposed to enabledVerificationProfiles, which says which families they are permitted to use. Array of verification profiles. For individual customers, this will include kyc_profile_a. For business customers, this will include kyb_profile_a. See KYC Flow for individuals or KYB Flow for businesses. See Verification Profile for individual status definitions and criteria breakdown or Verification Profile for business status definitions and criteria breakdown.
Show child attributes
Show child attributes
Ejemplo:
[
{
"criteria": {
"complete": [
"email_address",
"phone_number",
"residential_address",
"tax_identification_number"
],
"errors": [],
"pending": [],
"required": [
"identity_document",
"liveness_report_document"
]
},
"name": "kyc_profile_a",
"status": "incomplete"
}
]
Additional context on why the customer's verification reached its current status.
Show child attributes
Show child attributes
Ejemplo:
{
"message": "Please re-upload a clear photo of the front and back of the director's ID and correct the tax ID number.",
"reasons": [
{
"externalReason": "Cannot validate ID — upload a photo of the ID that is clear",
"reasonCode": "poor_image_quality",
"verificationProfiles": ["kyb_profile_a"]
},
{
"externalReason": "The tax identification number is not in a valid format for the selected country and ID type.",
"reasonCode": "invalid_tax_identification_number",
"verificationProfiles": ["kyb_profile_a"]
}
],
"updatedAt": "2026-07-16T21:04:00Z"
}
Última modificación el 27 de agosto de 2026