> ## 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.

# Upsert de uma entidade pessoa

> Cria ou atualiza uma pessoa no gu1 com detecção de duplicatas sobre ID externo, identificação nacional, e-mail e telefone para evitar duplicidade KYC.

## Visão Geral

O endpoint upsert cria inteligentemente uma nova pessoa ou atualiza uma existente com base em estratégias configuráveis de detecção de duplicatas. Ele lida automaticamente com conflitos e previne registros duplicados usando correspondência exata, correspondência difusa ou detecção de similaridade alimentada por IA.

## Endpoint

```
PUT http://api.gu1.ai/entities/upsert
```

## Autenticação

Requer uma chave de API válida no cabeçalho de autorização:

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

## Corpo da Requisição

<ParamField body="entity" type="object" required>
  Os dados da pessoa (mesma estrutura do endpoint Criar Pessoa)
</ParamField>

<ParamField body="options" type="object">
  Opções de configuração para o comportamento do upsert
</ParamField>

<ParamField body="options.conflictResolution" type="enum">
  Como lidar com conflitos quando uma pessoa existente é encontrada:

  * `source_wins` - Novos dados sobrescrevem dados existentes
  * `target_wins` - Mantém dados existentes, ignora novos dados
  * `manual_review` - Sinaliza para revisão manual sem atualizar
  * `smart_merge` (padrão) - Mescla inteligentemente ambos os conjuntos de dados
</ParamField>

<ParamField body="options.deduplicationStrategy" type="enum">
  Estratégia para detectar pessoas duplicadas:

  * `exact_match` - Correspondência por externalId e taxId (insensível a maiúsculas/minúsculas)
  * `fuzzy_match` - Correspondência de similaridade em nome e taxId (limite de 80%)
  * `ai_similarity` - Detecção de similaridade semântica alimentada por IA
  * `hybrid` (recomendado) - Correspondência exata com fallback difuso
</ParamField>

<ParamField body="options.createRelationships" type="boolean" default="true">
  Se deve criar automaticamente relacionamentos entre entidades
</ParamField>

## Resposta

<ResponseField name="success" type="boolean">
  Indica se a operação foi bem-sucedida
</ResponseField>

<ResponseField name="action" type="string">
  A ação realizada: `created` ou `updated`
</ResponseField>

<ResponseField name="entity" type="object">
  O estado final da pessoa após o upsert
</ResponseField>

<ResponseField name="previousEntity" type="object">
  O estado da pessoa antes da atualização (null se recém-criada)
</ResponseField>

<ResponseField name="confidence" type="number">
  Pontuação de confiança (0-1) para a correspondência de detecção de duplicatas
</ResponseField>

<ResponseField name="reasoning" type="string">
  Explicação de por que a pessoa foi criada/atualizada
</ResponseField>

<ResponseField name="conflicts" type="array">
  Array de conflitos em nível de campo detectados durante a mesclagem (se houver)
</ResponseField>

## Exemplos

### Upsert Simples (Comportamento Padrão)

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT http://api.gu1.ai/entities/upsert \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "entity": {
        "type": "person",
        "externalId": "customer_12345",
        "name": "María González",
        "countryCode": "AR",
        "taxId": "20-12345678-9",
        "entityData": {
          "person": {
            "firstName": "María",
            "lastName": "González",
            "dateOfBirth": "1985-03-15",
            "occupation": "Software Engineer",
            "income": 85000
          }
        }
      }
    }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('http://api.gu1.ai/entities/upsert', {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      entity: {
        type: 'person',
        externalId: 'customer_12345',
        name: 'María González',
        countryCode: 'AR',
        taxId: '20-12345678-9',
        entityData: {
          person: {
            firstName: 'María',
            lastName: 'González',
            dateOfBirth: '1985-03-15',
            occupation: 'Software Engineer',
            income: 85000
          }
        }
      }
    })
  });

  const result = await response.json();
  console.log(`Action: ${result.action}`); // 'created' ou 'updated'
  console.log(`Confidence: ${result.confidence}`);
  ```

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

  response = requests.put(
      'http://api.gu1.ai/entities/upsert',
      headers={
          'Authorization': 'Bearer YOUR_API_KEY',
          'Content-Type': 'application/json'
      },
      json={
          'entity': {
              'type': 'person',
              'externalId': 'customer_12345',
              'name': 'María González',
              'countryCode': 'AR',
              'taxId': '20-12345678-9',
              'entityData': {
                  'person': {
                      'firstName': 'María',
                      'lastName': 'González',
                      'dateOfBirth': '1985-03-15',
                      'occupation': 'Software Engineer',
                      'income': 85000
                  }
              }
          }
      }
  )

  result = response.json()
  print(f"Action: {result['action']}")
  print(f"Confidence: {result['confidence']}")
  ```
</CodeGroup>

### Upsert com Correspondência Difusa

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT http://api.gu1.ai/entities/upsert \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "entity": {
        "type": "person",
        "externalId": "customer_new_123",
        "name": "Maria Gonzales",
        "countryCode": "AR",
        "taxId": "20-12345678-9",
        "entityData": {
          "person": {
            "firstName": "Maria",
            "lastName": "Gonzales"
          }
        }
      },
      "options": {
        "deduplicationStrategy": "fuzzy_match",
        "conflictResolution": "smart_merge"
      }
    }'
  ```

  ```javascript JavaScript theme={null}
  // Corresponderá "Maria Gonzales" com "María González" existente
  // devido ao limite de similaridade de 80%+

  const response = await fetch('http://api.gu1.ai/entities/upsert', {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      entity: {
        type: 'person',
        externalId: 'customer_new_123',
        name: 'Maria Gonzales', // Pequena variação na ortografia
        countryCode: 'AR',
        taxId: '20-12345678-9',
        entityData: {
          person: {
            firstName: 'Maria',
            lastName: 'Gonzales'
          }
        }
      },
      options: {
        deduplicationStrategy: 'fuzzy_match',
        conflictResolution: 'smart_merge'
      }
    })
  });

  const result = await response.json();
  console.log(`Matched with confidence: ${result.confidence}`);
  console.log(`Reasoning: ${result.reasoning}`);
  ```

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

  # Corresponderá "Maria Gonzales" com "María González" existente
  response = requests.put(
      'http://api.gu1.ai/entities/upsert',
      headers={
          'Authorization': 'Bearer YOUR_API_KEY',
          'Content-Type': 'application/json'
      },
      json={
          'entity': {
              'type': 'person',
              'externalId': 'customer_new_123',
              'name': 'Maria Gonzales',  # Pequena variação
              'countryCode': 'AR',
              'taxId': '20-12345678-9',
              'entityData': {
                  'person': {
                      'firstName': 'Maria',
                      'lastName': 'Gonzales'
                  }
              }
          },
          'options': {
              'deduplicationStrategy': 'fuzzy_match',
              'conflictResolution': 'smart_merge'
          }
      }
  )

  result = response.json()
  print(f"Matched with confidence: {result['confidence']}")
  print(f"Reasoning: {result['reasoning']}")
  ```
</CodeGroup>

## Exemplos de Resposta

### Nova Pessoa Criada

```json theme={null}
{
  "success": true,
  "action": "created",
  "entity": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "externalId": "customer_12345",
    "type": "person",
    "name": "María González",
    ...
  },
  "previousEntity": null,
  "confidence": 1.0,
  "reasoning": "No existing entity found matching criteria. Created new entity.",
  "conflicts": []
}
```

### Pessoa Existente Atualizada

```json theme={null}
{
  "success": true,
  "action": "updated",
  "entity": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "externalId": "customer_12345",
    "type": "person",
    "name": "María González",
    "entityData": {
      "person": {
        "income": 95000
      }
    },
    ...
  },
  "previousEntity": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "entityData": {
      "person": {
        "income": 85000
      }
    },
    ...
  },
  "confidence": 1.0,
  "reasoning": "Exact match found on externalId. Updated existing entity with smart merge.",
  "conflicts": [
    {
      "field": "entityData.person.income",
      "oldValue": 85000,
      "newValue": 95000,
      "resolution": "source_wins"
    }
  ]
}
```

## Casos de Uso

### Importação de Dados do CRM

```javascript theme={null}
// Importar dados de clientes do CRM, evitando duplicatas
async function importCustomer(crmData) {
  const response = await fetch('http://api.gu1.ai/entities/upsert', {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      entity: {
        type: 'person',
        externalId: crmData.customerId,
        name: crmData.fullName,
        countryCode: crmData.country,
        taxId: crmData.taxId,
        entityData: {
          person: {
            firstName: crmData.firstName,
            lastName: crmData.lastName,
            income: crmData.annualIncome
          }
        },
        attributes: {
          source: 'crm_import',
          importDate: new Date().toISOString()
        }
      },
      options: {
        deduplicationStrategy: 'hybrid',
        conflictResolution: 'smart_merge'
      }
    })
  });

  return response.json();
}
```

### Enriquecimento Progressivo de Dados

```python theme={null}
def enrich_person_data(external_id, new_data):
    """Adicionar dados progressivamente à pessoa conforme ficam disponíveis"""
    response = requests.put(
        'http://api.gu1.ai/entities/upsert',
        headers={
            'Authorization': 'Bearer YOUR_API_KEY',
            'Content-Type': 'application/json'
        },
        json={
            'entity': {
                'type': 'person',
                'externalId': external_id,
                'name': new_data.get('name'),
                'countryCode': new_data.get('country'),
                'entityData': new_data.get('details', {}),
                'attributes': new_data.get('attributes', {})
            },
            'options': {
                'deduplicationStrategy': 'exact_match',
                'conflictResolution': 'smart_merge'  # Mesclar novo com existente
            }
        }
    )

    result = response.json()
    if result['action'] == 'updated':
        print(f"Enriched existing person with new data")
    return result
```

## Melhores Práticas

1. **Escolha a Estratégia Certa**:
   * `exact_match` para dados limpos e estruturados com IDs confiáveis
   * `fuzzy_match` para dados inseridos pelo usuário com possíveis erros de digitação
   * `hybrid` para a maioria dos cenários de produção

2. **Lidar com Conflitos Graciosamente**:
   * Use `smart_merge` para resolução automática
   * Use `manual_review` para dados críticos
   * Verifique o array `conflicts` na resposta para mudanças importantes

3. **Monitorar Pontuações de Confiança**:
   * Pontuações abaixo de 0.7 podem indicar correspondências fracas
   * Registre atualizações de baixa confiança para revisão

## Respostas de Erro

### 400 Bad Request

```json theme={null}
{
  "error": "Invalid tax ID format for country"
}
```

### 500 Internal Server Error

```json theme={null}
{
  "error": "Failed to upsert entity"
}
```

## Próximos Passos

* [Listar Pessoas](/pt/api-reference/person/list) - Consultar pessoas upsertadas
* [Atualizar Pessoa](/pt/api-reference/person/update) - Fazer atualizações direcionadas
* [Obter Pessoa](/pt/api-reference/person/get) - Recuperar detalhes completos da pessoa