Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spherepay.co/llms.txt

Use this file to discover all available pages before exploring further.

Update mutable fields on an existing business representative. Use this endpoint to correct or supplement information before the representative’s KYB verification is submitted — for example, to add a tax identification number, update a residential address, or adjust representation details such as title or ownership percentage. Only include fields you want to change; unspecified fields are left unchanged.

Endpoint

PATCH https://api.spherepay.co/v2/business-representative/{id}

Authentication

All requests must include a Bearer token in the Authorization header.
Authorization: Bearer <token>

Path parameters

id
string
required
The ID of the business representative to update.

Request parameters

address
object
Updated residential address. Required if personalInformation is provided.
personalInformation
object
Updated personal information. When any tax identification field is provided, all three fields and address are required.
representationDetails
object
Updated representation details.
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "address": {
      "line1": "350 Fifth Avenue",
      "city": "New York",
      "state": "NY",
      "postalCode": "10118",
      "country": "USA"
    }
  }'

Response fields

id
string
Unique identifier for the business representative.
customerId
string
The ID of the parent business customer.
type
string
The representative type ("individual").
email
string
The representative’s email address.
phone
string
The representative’s phone number.
representationDetails
object
Updated roles, ownership percentage, and related details.
verificationProfiles
object[]
Verification profile objects reflecting the current state of KYB criteria after the update.
createdAt
string
ISO 8601 timestamp of when the representative was created.
updatedAt
string
ISO 8601 timestamp of the most recent update.
{
  "id": "associatedPerson_d972d2f70b9f4d3c8d7cfb32593f395b",
  "customerId": "customer_2f283221a9d44ada800ac7f11f640402",
  "type": "individual",
  "email": "james.wilson@acmecorp.example.com",
  "phone": "+13125559876",
  "representationDetails": {
    "roles": ["ubo"],
    "ownershipPercentage": "50",
    "isControlPerson": true,
    "isSigner": true,
    "relationshipEstablishedAt": "2020-03-15",
    "title": "CEO"
  },
  "verificationProfiles": [
    {
      "name": "ubo_kyc_profile_a",
      "status": "incomplete",
      "criteria": {
        "complete": [
          "email_address",
          "phone_number",
          "residential_address",
          "tax_identification_number",
          "ownership_percentage",
          "is_control_person",
          "is_signer",
          "relationship_established_at",
          "title"
        ],
        "pending": [],
        "required": [
          "identity_document",
          "liveness_report_document",
          "proof_of_address_document"
        ],
        "errors": []
      }
    }
  ],
  "createdAt": "2026-03-10T00:00:08.986Z",
  "updatedAt": "2026-03-10T02:15:00.000Z"
}
Last modified on May 12, 2026