Pular para o conteúdo principal
List Business Representatives
curl --request GET \
  --url https://api.spherepay.co/v2/business-representative \
  --header 'Authorization: Bearer <token>'
{
  "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
  }
}
Recupere uma lista paginada de todos os representantes empresariais registrados na sua conta. Use o parâmetro de consulta customerId para limitar os resultados aos representantes de um cliente empresarial específico. A resposta inclui os detalhes de identidade, participação acionária, papéis e o estado atual dos critérios do perfil de verificação de cada representante — tornando este endpoint útil para rastrear o progresso do KYB em todos os UBOs.

Autorizações

​
Authorization
string
header
obrigatório

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

Parâmetros de consulta

​
page
string
padrão:1
obrigatório

Page number of the list (default: 1)

Exemplo:

1

​
limit
string
padrão:10
obrigatório

Number of items per page (default: 10)

Exemplo:

10

​
customerId
string
Minimum string length: 1

Resposta

​
data
object[]
obrigatório
​
pagination
object
obrigatório
Última modificação em 18 de junho de 2026