Atualizar Endereço, Telefone ou E-mail do Cliente

curl --request PATCH \ --url https://api.spherepay.co/v2/customer/{id} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "address": { "line1": "456 Market Street", "city": "San Francisco", "state": "CA", "postalCode": "94105", "country": "USA" }, "meta": { "internalUserId": "usr_9912" } } '

{ "id": "customer_f31121c389624d3697cbf3ea8830b7a4", "type": "individual", "email": "jane.smith@example.com", "phone": "+14155550123", "firstName": "Jane", "lastName": "Smith", "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": [] } } ], "meta": { "internalUserId": "usr_9912" }, "createdAt": "2026-03-09T20:46:31.305Z", "updatedAt": "2026-04-01T14:22:10.000Z" }

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

string

obrigatório

Customer ID

Exemplo:

"customer_f31121c389624d3697cbf3ea8830b7a4"

Corpo

application/json

address

object

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

Show child attributes

Exemplo:

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

Show child attributes

Resposta

Individual
Business

Response containing information about an individual customer.

string

obrigatório

Customer ID

Exemplo:

"customer_f31121c389624d3697cbf3ea8830b7a4"

verificationProfiles

object[]

obrigatório

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

Exemplo:

[
  {
    "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": []
    }
  }
]

createdAt

string

obrigatório

ISO 8601 formatted customer creation timestamp

Exemplo:

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

updatedAt

string

obrigatório

ISO 8601 formatted customer update timestamp

Exemplo:

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

type

enum<string>

obrigatório

Customer type

Opções disponíveis:

individual

Exemplo:

"individual"

string

Customer email address

Exemplo:

"jane.smith@example.com"

phone

string

Customer phone number

Exemplo:

"+14155550123"