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

# Verificação de enriquecimento de identidade global (API)

> Consulta à rede global de identidade via infraestrutura da Didit. Pago por chamada a partir de $0.20, sem contratos nem mínimos.

Identifica pessoas (nomes, datas de nascimento, moradas, telefones, e-mails, números de identificação nacionais) e uma pontuação de correspondência de nomes a partir de um e-mail e/ou número de telefone, através de uma rede global de informação de risco. É cobrado por pedido. A Didit disponibiliza este serviço através de `POST /v3/database-validation/` para que possa comparar os dados enviados com a rede de identidade ligada e receber resultados de correspondência normalizados. Trata-se de uma rede de enriquecimento de terceiros, e não de um registo governamental oficial e fidedigno: não apresente os seus resultados como verificação de fonte primária.

## Cobertura

* **Cobertura:** 50+ mercados
* **País:** Global
* **ID do serviço:** `glb_identity_enrichment`
* **Domínio de dados:** Identidade
* **Categoria:** IdentityEnrichment

## Entradas

| Campo | Obrigatório | Exemplo |
| - | -: | - |
| `email` | Não | `john.doe@example.com` |
| `phone` | Não | `+15550101000` |
| `first_name` | Não | `John` |
| `last_name` | Não | `Doe` |
| `full_name` | Não | `John Doe` |
| `country_of_residence` | Não | `US` |
| `vendor_data` | Não | `user-1234` |

* **Entradas obrigatórias:** —
* **Entradas opcionais:** `email`, `phone`, `first_name`, `last_name`, `full_name`, `country_of_residence`, `vendor_data`
* **Consentimento:** Obrigatório
* **Disponibilidade no fluxo:** Apenas API autónoma
* **Cobertura:** 50+ mercados
* **Preço:** \$0.20 por consulta bem-sucedida

Este serviço não é disponibilizado como passo de Validação de base de dados dentro de um fluxo. Essa restrição limita onde a verificação é executada, e não o que pode enviar: chame-o na API autónoma, onde fornece os dados diretamente.

## Parâmetros do corpo

**issuing\_state** `string` *required* (default: GLB)

Código de país ISO 3166-1 alfa-3 deste serviço de base de dados.

Exemplo: `GLB`

**services** `string` *required* (default: glb\_identity\_enrichment)

Array que contém o ID deste serviço. Fixar o serviço mantém o pedido limitado a esta base de dados específica.

Exemplo: `glb_identity_enrichment`

**consent** `boolean` *required* (default: true)

Consentimento explícito do utilizador final para este serviço.

Exemplo: `true`

**email** `string` (default: [john.doe@example.com](mailto:john.doe@example.com))

Endereço de e-mail.

Exemplo: `john.doe@example.com`

**phone** `string` (default: +15550101000)

Número de telefone em formato internacional.

Exemplo: `+15550101000`

**first\_name** `string` (default: John)

Nome próprio a validar.

Exemplo: `John`

**last\_name** `string` (default: Doe)

Apelido a validar.

Exemplo: `Doe`

**full\_name** `string`

Nome legal completo a validar.

Exemplo: `John Doe`

**country\_of\_residence** `string` (default: US)

País de residência opcional, em código ISO 3166-1 alfa-2. Usado apenas para focar a pesquisa de identidade.

Exemplo: `US`

**vendor\_data** `string` (default: user-1234)

A sua referência estável do utilizador para esta pessoa, como o seu ID de utilizador interno. A Didit usa-a para associar as verificações autónomas ao mesmo utilizador final e reduzir o ruído na deteção de duplicados.

Exemplo: `user-1234`

## Regras de entrada e notas de validação

* Indique pelo menos um de `email` ou `phone`: são as chaves de pesquisa. Um pedido sem nenhum dos dois não pode executar uma pesquisa de enriquecimento e é rejeitado antes da consulta à fonte (não é cobrado).
* Adicione um nome sempre que o tiver: a fonte pontua a pesquisa em função dele. Envie `first_name` e `last_name`, que são os campos que o mapa `validation` da resposta compara. Um pedido que envie apenas `full_name` continua a ser pontuado pela fonte, mas é devolvido com um `validation` vazio e um `match_type` de nível superior nulo.
* `country_of_residence` é um código ISO 3166-1 alfa-2 usado para focar a pesquisa.
* Cada pesquisa concluída é cobrada, incluindo a que não identifica nenhuma pessoa (`persons_found: 0`). Apenas um pedido rejeitado antes da pesquisa, sem `email` nem `phone`, é gratuito.

## How to call it

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=GLB" \
  -F "services=glb_identity_enrichment" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "email=john.doe@example.com" \
  -F "phone=+15550101000" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "country_of_residence=US"
```

```python Python theme={null}
from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="GLB",
    services=["glb_identity_enrichment"],
    consent=True,
    first_name="John",
    last_name="Doe",
    phone="+15550101000",
    email="john.doe@example.com",
    country_of_residence="US",
    vendor_data="user-1234",
)
print(result)
```

```javascript Node.js theme={null}
import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.databaseValidation.validate({
  issuing_state: "GLB",
  services: ["glb_identity_enrichment"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  phone: "+15550101000",
  email: "john.doe@example.com",
  country_of_residence: "US",
  vendor_data: "user-1234",
});
console.log(result);
```

```go Go theme={null}
ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.DatabaseValidation.Validate(ctx, didit.DatabaseValidationValidateParams{
	IssuingState:       "GLB",
	Services:           didit.Some([]string{"glb_identity_enrichment"}),
	Consent:            didit.Bool(true),
	FirstName:          didit.String("John"),
	LastName:           didit.String("Doe"),
	Phone:              didit.String("+15550101000"),
	Email:              didit.String("john.doe@example.com"),
	CountryOfResidence: didit.String("US"),
	VendorData:         didit.String("user-1234"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)
```

```java Java theme={null}
import java.util.List;
import me.didit.Didit;
import me.didit.types.DatabaseValidationValidateParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.databaseValidation().validate(DatabaseValidationValidateParams.builder()
        .issuingState("GLB")
        .services(List.of("glb_identity_enrichment"))
        .consent(true)
        .firstName("John")
        .lastName("Doe")
        .phone("+15550101000")
        .email("john.doe@example.com")
        .countryOfResidence("US")
        .vendorData("user-1234")
        .build());
System.out.println(result);
```

```php PHP theme={null}
<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->databaseValidation->validate([
    'issuing_state' => 'GLB',
    'services' => ['glb_identity_enrichment'],
    'consent' => true,
    'first_name' => 'John',
    'last_name' => 'Doe',
    'phone' => '+15550101000',
    'email' => 'john.doe@example.com',
    'country_of_residence' => 'US',
    'vendor_data' => 'user-1234',
]);
print_r($result->toArray());
```

```ruby Ruby theme={null}
require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.database_validation.validate(
  issuing_state: "GLB",
  services: ["glb_identity_enrichment"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  phone: "+15550101000",
  email: "john.doe@example.com",
  country_of_residence: "US",
  vendor_data: "user-1234"
)
puts result.to_h
```

```csharp .NET theme={null}
using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.DatabaseValidation.ValidateAsync(new DatabaseValidationValidateParams
{
    IssuingState = "GLB",
    Services = new string[] { "glb_identity_enrichment" },
    Consent = true,
    FirstName = "John",
    LastName = "Doe",
    Phone = "+15550101000",
    Email = "john.doe@example.com",
    CountryOfResidence = "US",
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Cada chamada bem-sucedida devolve HTTP `200`. O campo **`outcome_code`** indica o que aconteceu de facto, distinguindo, por exemplo, uma verdadeira falta de correspondência biométrica (`BIOMETRIC_NO_MATCH`) de uma selfie que não pôde ser lida (`BIOMETRIC_IMAGE_UNUSABLE`). O `status` apresentado é o estado predefinido da funcionalidade; as suas [ações de Correspondência parcial / Sem correspondência](https://docs.didit.me/pt/core-technology/database-validation/database-validation-warnings.md) configuradas podem substituí-lo.

**`MATCH`**: O e-mail ou telefone permitiu identificar uma pessoa, e o nome da melhor correspondência coincide com o nome que enviou.

```json 200 OK — MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "GLB",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "glb_identity_enrichment",
      "service_name": "Global - Identity Enrichment",
      "source_data": {
        "first_name": "John",
        "last_name": "Doe",
        "persons_found": 1
      },
      "validation": {
        "full_name": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`**: O e-mail ou telefone permitiu identificar uma pessoa, mas o nome da melhor correspondência corresponde apenas parcialmente ao nome que enviou.

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "GLB",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "glb_identity_enrichment",
      "service_name": "Global - Identity Enrichment",
      "source_data": {
        "first_name": "John",
        "last_name": "Dow",
        "persons_found": 1
      },
      "validation": {
        "full_name": "partial_match"
      }
    }
  ]
}
```

**`NO_MATCH`**: O e-mail ou telefone permitiu identificar uma pessoa, mas o nome da melhor correspondência não corresponde ao nome que enviou.

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "GLB",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "glb_identity_enrichment",
      "service_name": "Global - Identity Enrichment",
      "source_data": {
        "first_name": "Jane",
        "last_name": "Roe",
        "persons_found": 1
      },
      "validation": {
        "full_name": "no_match"
      }
    }
  ]
}
```

**`INCONCLUSIVE`**: O e-mail ou telefone permitiu identificar uma pessoa, mas não foi devolvida nenhuma pontuação de nome, por exemplo porque o pedido não incluía nome. Nada é afirmado, pelo que `validation` fica vazio, `match_type` é nulo e a verificação é encaminhada para revisão. Envie `first_name` + `last_name` para obter um resultado com pontuação: são esses os campos que a comparação de `validation` analisa, e um pedido que contenha apenas `full_name` obtém um `outcome_code` com pontuação, mas continua com `validation` vazio.

```json 200 OK — INCONCLUSIVE theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "GLB",
  "match_type": null,
  "validations": [
    {
      "outcome_code": "INCONCLUSIVE",
      "service_id": "glb_identity_enrichment",
      "service_name": "Global - Identity Enrichment",
      "source_data": {
        "persons_found": 1
      },
      "validation": {}
    }
  ]
}
```

**`DOCUMENT_NOT_FOUND`**: O e-mail ou telefone não permitiu identificar nenhuma pessoa (`persons_found: 0`). Não há nome para comparar, pelo que `validation` fica vazio e `match_type` é nulo; o resultado é um negativo definitivo e segue a sua ação de Sem correspondência. A pesquisa continua a ser cobrada.

```json 200 OK — DOCUMENT_NOT_FOUND theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "GLB",
  "match_type": null,
  "validations": [
    {
      "outcome_code": "DOCUMENT_NOT_FOUND",
      "service_id": "glb_identity_enrichment",
      "service_name": "Global - Identity Enrichment",
      "source_data": {
        "persons_found": 0
      },
      "validation": {}
    }
  ]
}
```

## Dados devolvidos

Os campos exatos apresentados em `source_data` dependem do que o registo devolve. O exemplo gerado para `glb_identity_enrichment` documenta atualmente esta estrutura normalizada:

* `first_name`
* `last_name`
* `persons_found`

## Preços e SLAs

As consultas de Global - Identity Enrichment só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$0.20 USD.
* **Faturação:** por consulta bem-sucedida. Não lhe é cobrado quando o registo está inacessível, quando faltam campos obrigatórios ou quando o pedido é rejeitado antes de chegar à fonte.
* **Latência:** p95 típico \< 2 s.
* **Disponibilidade:** 99.9% por trimestre do lado da Didit; a disponibilidade da fonte a jusante varia consoante o país e o conjunto de dados.

## Continuar a ler

* [Visão geral da Validação de base de dados global](https://docs.didit.me/pt/getting-started/database-validation-pricing.md)
* [Visão geral da Validação de base de dados](https://docs.didit.me/pt/core-technology/database-validation/overview.md)
* [Códigos de resultado](https://docs.didit.me/pt/core-technology/database-validation/database-validation-outcome-codes.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.