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 the full profile of a single business representative by their ID. The response includes the representative’s contact details, ownership stake, assigned roles, and a breakdown of their KYB verification criteria — showing which requirements are complete, which are still required, and any errors that need to be resolved before the representative can be approved.

Endpoint

GET 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 retrieve (prefixed associatedPerson_).
  -H "Authorization: Bearer <token>"

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
verificationProfiles
object[]
createdAt
string
ISO 8601 timestamp of when the representative was created.
updatedAt
string
ISO 8601 timestamp of the last 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-10T00:00:08.986Z"
}
Last modified on May 12, 2026