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.

Retrieve a paginated list of all business representatives registered in your account. Use the customerId query parameter to scope results to the representatives of a specific business customer. The response includes each representative’s identity details, ownership stake, roles, and the current state of their verification profile criteria — making this endpoint useful for tracking KYB progress across all UBOs.

​
Endpoint

GET https://api.spherepay.co/v2/business-representative

​
Authentication

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

​
Query parameters

​
page
string
default:"1"
Page number to return.
​
limit
string
default:"10"
Number of results per page.
​
customerId
string
Filter results to representatives belonging to a specific business customer.
  -H "Authorization: Bearer <token>"

​
Response fields

​
data
object[]
Array of business representative objects.
​
pagination
object
{
  "data": [
    {
      "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-10T00:00:08.986Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrevious": false
  }
}
Last modified on May 12, 2026