Skip to main content
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": {
    "line1": "233 South Wacker Drive",
    "line2": "Suite 4700",
    "city": "Chicago",
    "postalCode": "60606",
    "state": "IL",
    "country": "USA"
  },
  "personalInformation": {
    "taxIdentificationNumber": "123456789",
    "taxIdentificationNumberType": "ssn",
    "taxIdentificationNumberCountry": "USA",
    "taxIdentificationNumberDescription": "<string>",
    "gender": "male",
    "countryOfBirth": "USA",
    "nationality": "USA",
    "middleName": "James",
    "occupationSocCode": "15-1132",
    "residencyCountry": "USA",
    "sourceOfFunds": "salary"
  },
  "meta": {
    "key": "value"
  }
}
'
{
  "id": "customer_f31121c389624d3697cbf3ea8830b7a4",
  "verificationProfiles": [
    {
      "name": "kyc_profile_a",
      "status": "incomplete",
      "criteria": {
        "complete": [
          "email_address",
          "phone_number",
          "residential_address",
          "tax_identification_number"
        ],
        "pending": [],
        "required": [
          "identity_document",
          "liveness_report_document"
        ],
        "errors": []
      }
    }
  ],
  "tosStatus": "incomplete",
  "createdAt": "2026-03-09T20:46:31.305Z",
  "updatedAt": "2026-03-09T20:46:31.305Z",
  "type": "individual",
  "email": "jane.smith@example.com",
  "phone": "+14155550123",
  "meta": {},
  "firstName": "Jane",
  "lastName": "Smith",
  "dateOfBirth": "1990-01-15",
  "personalInformation": {
    "taxIdentificationNumberType": "ssn",
    "taxIdentificationNumberCountry": "USA",
    "taxIdentificationNumberDescription": "<string>",
    "gender": "male",
    "countryOfBirth": "USA",
    "nationality": "USA",
    "middleName": "James",
    "occupationSocCode": "15-1132",
    "residencyCountry": "USA",
    "sourceOfFunds": "salary"
  }
}
Use this endpoint to update mutable fields on an existing individual customer. You can update the customer’s address, personal information, and metadata at any time before KYC submission. Once a KYC review has been submitted, identity fields such as name, date of birth, and tax identification number are locked and cannot be changed — only contact details and metadata remain editable.
This endpoint currently supports updates for individual customers only. Business customer fields must be managed through the KYC link flow.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Customer ID

Example:

"customer_f31121c389624d3697cbf3ea8830b7a4"

Body

application/json
​
address
object

The address of the customer. Required if personalInformation is provided.

Example:
{
  "line1": "233 South Wacker Drive",
  "line2": "Suite 4700",
  "city": "Chicago",
  "postalCode": "60606",
  "state": "IL",
  "country": "USA"
}
​
personalInformation
object

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.

​
meta
object

The customer metadata

Example:
{ "key": "value" }

Response

Response containing information about an individual customer.

​
id
string
required

Customer ID

Example:

"customer_f31121c389624d3697cbf3ea8830b7a4"

​
verificationProfiles
object[]
required

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.

Example:
[
  {
    "name": "kyc_profile_a",
    "status": "incomplete",
    "criteria": {
      "complete": [
        "email_address",
        "phone_number",
        "residential_address",
        "tax_identification_number"
      ],
      "pending": [],
      "required": [
        "identity_document",
        "liveness_report_document"
      ],
      "errors": []
    }
  }
]
​
tosStatus
enum<string>
required

Customer Terms of Service acceptance status (incomplete | pending | approved).

Available options:
incomplete,
pending,
approved
Example:

"incomplete"

​
createdAt
string
required

ISO 8601 formatted customer creation timestamp

Example:

"2026-03-09T20:46:31.305Z"

​
updatedAt
string
required

ISO 8601 formatted customer update timestamp

Example:

"2026-03-09T20:46:31.305Z"

​
type
enum<string>
required

Customer type

Available options:
individual
Example:

"individual"

​
email
string

Customer email address

Example:

"jane.smith@example.com"

​
phone
string

Customer phone number

Example:

"+14155550123"

​
meta
object
​
firstName
string

Customer first name (individual customers only)

Example:

"Jane"

​
lastName
string

Customer last name (individual customers only)

Example:

"Smith"

​
dateOfBirth
string

The customer's date of birth in YYYY-MM-DD format (individual customers only).

Example:

"1990-01-15"

​
personalInformation
object

Personal information for an individual customer, echoed back from the most recent submission. The tax identification number is omitted from responses for privacy.

Last modified on June 18, 2026