> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gu1.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar personas

> Consultar y filtrar personas en tu organización — para entidades de persona en la plataforma KYC y análisis de riesgo gu1, con ejemplos para list.

## Resumen

Recupera una lista de personas con filtrado opcional por país, ID fiscal o ID externo. Devuelve hasta 100 personas por solicitud.

## Endpoint

```
GET http://api.gu1.ai/entities?type=person
```

## Autenticación

Requiere una clave API válida en el encabezado Authorization:

```bash theme={null}
Authorization: Bearer YOUR_API_KEY
```

## Parámetros de Consulta

<ParamField query="type" type="string" required>
  Debe establecerse en `person` para recuperar solo personas
</ParamField>

<ParamField query="country" type="string">
  Filtrar por código de país ISO 3166-1 alpha-2 (ej., "US", "BR", "AR")
</ParamField>

<ParamField query="taxId" type="string">
  Filtrar por número de identificación fiscal exacto
</ParamField>

<ParamField query="externalId" type="string">
  Filtrar por tu identificador externo
</ParamField>

## Respuesta

<ResponseField name="entities" type="array">
  Array de objetos de persona, cada uno conteniendo:

  * `id` - ID interno de gu1
  * `externalId` - Tu ID externo
  * `organizationId` - Tu ID de organización
  * `type` - Siempre "person"
  * `name` - Nombre de la persona
  * `taxId` - ID fiscal
  * `countryCode` - Código de país
  * `riskScore` - Puntuación de riesgo (0-100)
  * `riskFactors` - Array de factores de riesgo
  * `status` - Estado de la persona
  * `kycVerified` - Estado de verificación KYC
  * `kycProvider` - Nombre del proveedor KYC
  * `kycData` - Datos de verificación KYC
  * `entityData` - Datos específicos de la persona
  * `attributes` - Atributos personalizados
  * `createdAt` - Marca de tiempo de creación
  * `updatedAt` - Marca de tiempo de última actualización
  * `deletedAt` - Marca de tiempo de eliminación (null si está activa)
</ResponseField>

## Ejemplos

### Listar Todas las Personas

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "http://api.gu1.ai/entities?type=person" \
    -H "Authorization: Bearer YOUR_API_KEY"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('http://api.gu1.ai/entities?type=person', {
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  });

  const data = await response.json();
  console.log(`Found ${data.entities.length} persons`);
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'http://api.gu1.ai/entities',
      headers={
          'Authorization': 'Bearer YOUR_API_KEY'
      },
      params={'type': 'person'}
  )

  data = response.json()
  print(f"Found {len(data['entities'])} persons")
  ```
</CodeGroup>

### Filtrar por País

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "http://api.gu1.ai/entities?type=person&country=BR" \
    -H "Authorization: Bearer YOUR_API_KEY"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'http://api.gu1.ai/entities?type=person&country=BR',
    {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
      }
    }
  );

  const data = await response.json();
  console.log(`Found ${data.entities.length} Brazilian customers`);
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'http://api.gu1.ai/entities',
      headers={'Authorization': 'Bearer YOUR_API_KEY'},
      params={
          'type': 'person',
          'country': 'BR'
      }
  )

  brazilian_customers = response.json()['entities']
  print(f"Found {len(brazilian_customers)} Brazilian customers")
  ```
</CodeGroup>

### Buscar por ID Externo

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "http://api.gu1.ai/entities?type=person&externalId=customer_12345" \
    -H "Authorization: Bearer YOUR_API_KEY"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'http://api.gu1.ai/entities?type=person&externalId=customer_12345',
    {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
      }
    }
  );

  const data = await response.json();
  const person = data.entities[0]; // External IDs should be unique
  console.log('Found person:', person.name);
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'http://api.gu1.ai/entities',
      headers={'Authorization': 'Bearer YOUR_API_KEY'},
      params={
          'type': 'person',
          'externalId': 'customer_12345'
      }
  )

  entities = response.json()['entities']
  if entities:
      print(f"Found person: {entities[0]['name']}")
  ```
</CodeGroup>

### Buscar por Tax ID

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "http://api.gu1.ai/entities?type=person&taxId=20-12345678-9" \
    -H "Authorization: Bearer YOUR_API_KEY"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'http://api.gu1.ai/entities?type=person&taxId=20-12345678-9',
    {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
      }
    }
  );

  const data = await response.json();
  if (data.entities.length > 0) {
    console.log('Person found:', data.entities[0].name);
  }
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'http://api.gu1.ai/entities',
      headers={'Authorization': 'Bearer YOUR_API_KEY'},
      params={
          'type': 'person',
          'taxId': '20-12345678-9'
      }
  )

  entities = response.json()['entities']
  if entities:
      print(f"Person found: {entities[0]['name']}")
  ```
</CodeGroup>

## Ejemplo de Respuesta

```json theme={null}
{
  "entities": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "customer_12345",
      "organizationId": "8e2f89ab-c216-4eb4-90eb-ca5d44499aaa",
      "type": "person",
      "name": "María González",
      "taxId": "20-12345678-9",
      "countryCode": "AR",
      "riskScore": 25,
      "riskFactors": [
        {
          "factor": "new_customer",
          "impact": 15,
          "description": "Customer registered within last 30 days"
        }
      ],
      "status": "active",
      "kycVerified": true,
      "kycProvider": "gueno_ai",
      "kycData": {
        "verificationDate": "2024-10-03T14:30:00Z",
        "overallStatus": "approved"
      },
      "entityData": {
        "person": {
          "firstName": "María",
          "lastName": "González",
          "dateOfBirth": "1985-03-15",
          "nationality": "AR",
          "occupation": "Software Engineer",
          "income": 85000
        }
      },
      "attributes": {
        "email": "maria.gonzalez@example.com",
        "phone": "+54 11 1234-5678"
      },
      "createdAt": "2024-10-03T14:30:00.000Z",
      "updatedAt": "2024-10-03T14:35:00.000Z",
      "deletedAt": null
    }
  ]
}
```

## Casos de Uso

### Monitoreo de Clientes de Alto Riesgo

Consultar todas las personas y filtrar por puntuación de riesgo:

```javascript theme={null}
const response = await fetch('http://api.gu1.ai/entities?type=person', {
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
});

const data = await response.json();
const highRiskCustomers = data.entities.filter(e => e.riskScore > 70);

console.log(`Found ${highRiskCustomers.length} high-risk customers requiring review`);
highRiskCustomers.forEach(person => {
  console.log(`- ${person.name} (Risk: ${person.riskScore})`);
});
```

### Panel de Cumplimiento KYC

Obtener todos los clientes no verificados para el panel de cumplimiento:

```python theme={null}
import requests

response = requests.get(
    'http://api.gu1.ai/entities',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
    params={'type': 'person'}
)

persons = response.json()['entities']
unverified = [p for p in persons if not p['kycVerified']]

print(f"Unverified customers: {len(unverified)}")
for person in unverified:
    print(f"- {person['name']} ({person['externalId']})")
```

## Respuestas de Error

### 401 Unauthorized

```json theme={null}
{
  "error": "Invalid or missing API key"
}
```

### 500 Internal Server Error

```json theme={null}
{
  "error": "Failed to search entities"
}
```

## Límites

* **Máximo de resultados por solicitud**: 100 personas
* **Parámetros de consulta**: Pueden combinarse para filtrado avanzado
* **Límites de tasa**: Aplican según tu nivel de plan

## Próximos Pasos

* [Obtener Detalles de Persona](/es/api-reference/person/get) - Recuperar información completa de una persona específica
* [Crear Persona](/es/api-reference/person/create) - Agregar nuevas personas a tu organización
* [Actualizar Persona](/es/api-reference/person/update) - Modificar atributos de persona