Effortless customer verification now available   View changelog
Sphere Paysphere
Customer

Update a Customer by ID

Updates a customer by ID.

PATCH
/v2/customer/{customer_id}
AuthorizationBearer <token>

JWT Bearer token authentication

In: header

Path Parameters

customer_idstring

The customer's unique ID generated by SpherePay upon customer creation.

Match^customer_[a-z0-9]+$
typestring

The type of customer that can be onboarded. Acceptable inputs are individual and business.

Value in"individual" | "business"
addressobject

The customer's address.

personalInformationobject
typestring

The type of customer that can be onboarded. Acceptable inputs are individual and business.

Value in"individual" | "business"
addressobject

The customer's address.

businessInformationobject

Response Body

curl -X PATCH "https://api.sandbox.spherepay.co/v2/customer/customer_1ab2c3d4" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "individual",
    "email": "johndoe@example.com",
    "phone": "+1234567890",
    "address": {
      "line1": "123 Main St",
      "line2": "Apt 1",
      "city": "Anytown",
      "state": "CA",
      "postalCode": "12345",
      "country": "USA"
    },
    "personalInformation": {
      "firstName": "John",
      "lastName": "Doe",
      "taxIdentificationNumber": "1234567890",
      "taxIdentificationNumberType": "ssn"
    }
  }'

{
  "id": "customer_2da22520a7e64bd2963c7dd6c807e875",
  "type": "individual",
  "email": "johndoe123@gmail.com",
  "firstName": "John",
  "lastName": "Doe",
  "verificationProfiles": [
    {
      "name": "kyc_profile_a",
      "status": "incomplete",
      "criteria": {
        "complete": [],
        "pending": [],
        "required": [],
        "errors": []
      }
    }
  ]
}

{
  "ts": "2025-04-20T00:09:16.870Z",
  "error": {
    "information": [
      "Required"
    ]
  }
}

{
  "ts": "2025-04-20T00:09:16.870Z",
  "error": {
    "general": "{{information}} Not Found"
  }
}