Saltar al contenido principal
List Business Representatives
curl --request GET \
  --url https://api.spherepay.co/v2/business-representative \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.spherepay.co/v2/business-representative"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.spherepay.co/v2/business-representative', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.spherepay.co/v2/business-representative",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.spherepay.co/v2/business-representative"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.spherepay.co/v2/business-representative")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.spherepay.co/v2/business-representative")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "associatedPerson_d972d2f70b9f4d3c8d7cfb32593f395b",
      "customerId": "customer_2f283221a9d44ada800ac7f11f640402",
      "type": "individual",
      "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",
      "email": "james.wilson@acmecorp.example.com",
      "phone": "+13125559876",
      "representationDetails": {
        "roles": [
          "ubo"
        ],
        "ownershipPercentage": "50",
        "isControlPerson": true,
        "isSigner": true,
        "relationshipEstablishedAt": "2020-03-15",
        "title": "CEO"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrevious": false
  }
}
{
"status": 400,
"detail": "Invalid request parameters",
"code": "address/invalid",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}
{
"status": 404,
"detail": "Resource not found",
"code": "resource/not-found",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c"
}
{
"status": 422,
"detail": "Validation failed",
"code": "validation/failed",
"correlationId": "28c61e885c6e5eaa78c1a2183a9b883c",
"errors": [
{
"detail": "Invalid email format",
"pointer": "/email"
},
{
"detail": "Name is required",
"pointer": "/name"
}
]
}
Recupera una lista paginada de todos los representantes empresariales registrados en tu cuenta. Usa el parámetro de consulta customerId para limitar los resultados a los representantes de un cliente empresarial específico. La respuesta incluye los detalles de identidad de cada representante, participación de propiedad, roles y el estado actual de sus criterios de perfil de verificación — haciendo que este endpoint sea útil para rastrear el progreso de KYB en todos los UBOs.

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de consulta

page
string
predeterminado:1
requerido

Page number of the list (default: 1)

Ejemplo:

1

limit
string
predeterminado:10
requerido

Number of items per page (default: 10)

Ejemplo:

10

customerId
string
Minimum string length: 1

Respuesta

data
object[]
requerido
pagination
object
requerido
Última modificación el 22 de junio de 2026