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

# API de verificação residencial do Canadá: identidade

> Valide dados residenciais no Canadá em bases oficiais com a Didit. Pagamento por chamada a partir de $0.42, sem contratos nem mínimos.

Verifica os dados informados em relação aos dados telefônicos das operadoras de rede móvel. É necessária uma solicitação junto à agência. A Didit disponibiliza este serviço por meio de `POST /v3/database-validation/` para que você possa verificar os dados enviados em relação à fonte oficial e receber resultados de correspondência normalizados.

## Cobertura

* **Cobertura:** \~ 90%
* **País:** Canadá
* **ID do serviço:** `can_residential`
* **Domínio de dados:** Endereço
* **Categoria:** Residencial

## Entradas

| Campo | Obrigatório | Exemplo |
| - | -: | - |
| `first_name` | Sim | `John` |
| `last_name` | Sim | `Doe` |
| `address.street_1` | Sim | `123 Sample Street` |
| `address.postal_code` | Sim | `10001` |
| `phone` | Sim | `+15550101000` |
| `date_of_birth` | Não | `1990-01-01` |
| `address.street_2` | Não | `Unit 4` |
| `address.city` | Não | `Sample City` |
| `address.region` | Não | `Sample State` |
| `vendor_data` | Não | `user-1234` |

* **Entradas obrigatórias:** `first_name`, `last_name`, `address.street_1`, `address.postal_code`, `phone`
* **Entradas opcionais:** `date_of_birth`, `address.street_2`, `address.city`, `address.region`, `vendor_data`
* **Consentimento:** Obrigatório
* **Disponibilidade no workflow:** Disponível no workflow
* **Cobertura:** \~ 90%
* **Preço:** \$0.42 por consulta bem-sucedida

## Parâmetros do corpo

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

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

Exemplo: `CAN`

**services** `string` *required* (default: can\_residential)

Array que contém o ID deste serviço. Fixar o serviço mantém a requisição restrita exatamente a este banco de dados.

Exemplo: `can_residential`

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

Consentimento explícito do usuário final para este serviço.

Exemplo: `true`

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

Nome a ser validado.

Exemplo: `John`

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

Sobrenome a ser validado.

Exemplo: `Doe`

**address** `object` *required* (default: \{"street\_1":"123 Sample Street","street\_2":"Unit 4","city":"Sample City","region":"Sample State","postal\_code":"10001","country":"US"})

Objeto estruturado de endereço residencial. Use `street_1`, `street_2`, `city`, `region`, `postal_code` e `country`. Uma string de endereço completa no formato legado ainda é aceita, mas não é recomendada.

Exemplo: `{"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}`

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

Número de telefone em formato internacional.

Exemplo: `+15550101000`

**date\_of\_birth** `string`

Data de nascimento no formato `YYYY-MM-DD`.

Exemplo: `1990-01-01`

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

Sua referência estável de usuário para esta pessoa, como o seu ID interno de usuário. A Didit a utiliza para vincular verificações avulsas ao mesmo usuário final e reduzir o ruído na detecção de duplicatas.

Exemplo: `user-1234`

## Regras de entrada e observações de validação

* Para serviços de endereço, envie campos de endereço estruturados em vez de uma única string `address` sempre que possível.
* `address.street_1` é o logradouro, incluindo o número e o tipo de logradouro.
* `address.street_2` é o apartamento, unidade, edifício, andar ou linha adicional do endereço. Envie-o apenas quando você o tiver.
* `address.city` é a cidade, subúrbio, distrito, localidade ou bairro.
* `address.region` é o estado, província, região ou município.
* `address.postal_code` é o código postal (CEP).
* Os serviços de banco de dados baseados em endereço exigem, no mínimo, o logradouro e o código postal; requisições rejeitadas antes da consulta à fonte não são cobradas.

## Como fazer a chamada

```bash cURL theme={null}
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=CAN" \
  -F "services=can_residential" \
  -F "vendor_data=user-1234" \
  -F "consent=true" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F 'address={"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}' \
  -F "phone=+15550101000"
```

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

# Reads DIDIT_API_KEY.
client = Didit()

result = client.database_validation.validate(
    issuing_state="CAN",
    services=["can_residential"],
    consent=True,
    first_name="John",
    last_name="Doe",
    address={"street_1": "123 Sample Street", "street_2": "Unit 4", "city": "Sample City", "region": "Sample State", "postal_code": "10001", "country": "US"},
    phone="+15550101000",
    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: "CAN",
  services: ["can_residential"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  address: { street_1: "123 Sample Street", street_2: "Unit 4", city: "Sample City", region: "Sample State", postal_code: "10001", country: "US" },
  phone: "+15550101000",
  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: "CAN",
	Services:     didit.Some([]string{"can_residential"}),
	Consent:      didit.Bool(true),
	FirstName:    didit.String("John"),
	LastName:     didit.String("Doe"),
	Address:      didit.Some[any](map[string]any{"street_1": "123 Sample Street", "street_2": "Unit 4", "city": "Sample City", "region": "Sample State", "postal_code": "10001", "country": "US"}),
	Phone:        didit.String("+15550101000"),
	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("CAN")
        .services(List.of("can_residential"))
        .consent(true)
        .firstName("John")
        .lastName("Doe")
        .address(DatabaseValidationValidateParams.Address.ofVariant1(DatabaseValidationValidateParams.Address.Variant1.builder()
                .street1("123 Sample Street")
                .street2("Unit 4")
                .city("Sample City")
                .region("Sample State")
                .postalCode("10001")
                .country("US")
                .build()))
        .phone("+15550101000")
        .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' => 'CAN',
    'services' => ['can_residential'],
    'consent' => true,
    'first_name' => 'John',
    'last_name' => 'Doe',
    'address' => ['street_1' => '123 Sample Street', 'street_2' => 'Unit 4', 'city' => 'Sample City', 'region' => 'Sample State', 'postal_code' => '10001', 'country' => 'US'],
    'phone' => '+15550101000',
    '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: "CAN",
  services: ["can_residential"],
  consent: true,
  first_name: "John",
  last_name: "Doe",
  address: { street_1: "123 Sample Street", street_2: "Unit 4", city: "Sample City", region: "Sample State", postal_code: "10001", country: "US" },
  phone: "+15550101000",
  vendor_data: "user-1234"
)
puts result.to_h
```

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

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

var result = await client.DatabaseValidation.ValidateAsync(new DatabaseValidationValidateParams
{
    IssuingState = "CAN",
    Services = new string[] { "can_residential" },
    Consent = true,
    FirstName = "John",
    LastName = "Doe",
    Address = new Dictionary<string, object> { ["street_1"] = "123 Sample Street", ["street_2"] = "Unit 4", ["city"] = "Sample City", ["region"] = "Sample State", ["postal_code"] = "10001", ["country"] = "US" },
    Phone = "+15550101000",
    VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));
```

Toda chamada bem-sucedida retorna HTTP `200`. O campo **`outcome_code`** informa o que de fato aconteceu, distinguindo, por exemplo, uma divergência biométrica real (`BIOMETRIC_NO_MATCH`) de uma selfie que não pôde ser lida (`BIOMETRIC_IMAGE_UNUSABLE`). O `status` exibido é o status padrão do recurso; as [ações de Partial Match / No Match](https://docs.didit.me/pt-br/core-technology/database-validation/database-validation-warnings.md) que você configurou podem substituí-lo.

**`MATCH`**: o registro confirmou a identidade e todos os campos verificados corresponderam.

```json 200 OK — MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "CAN",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "can_residential",
      "service_name": "Canada Residential",
      "source_data": {
        "address": "123 Sample Street",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "last_name": "Doe"
      },
      "validation": {
        "address": "full_match",
        "full_name": "full_match"
      }
    }
  ]
}
```

**`PARTIAL_MATCH`**: um ou mais dos campos que este serviço compara não corresponderam totalmente. Neste exemplo, `full_name` não correspondeu, enquanto `address` correspondeu.

```json 200 OK — PARTIAL_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "In Review",
  "issuing_state": "CAN",
  "match_type": "partial_match",
  "validations": [
    {
      "outcome_code": "PARTIAL_MATCH",
      "service_id": "can_residential",
      "service_name": "Canada Residential",
      "source_data": {
        "address": "123 Sample Street",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "last_name": "Doe"
      },
      "validation": {
        "address": "full_match",
        "full_name": "no_match"
      }
    }
  ]
}
```

**`NO_MATCH`**: o registro não retornou nenhuma correspondência para os dados enviados.

```json 200 OK — NO_MATCH theme={null}
{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "CAN",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "can_residential",
      "service_name": "Canada Residential",
      "source_data": {
        "address": "NO_MATCH",
        "full_name": "NO_MATCH"
      },
      "validation": {
        "address": "no_match",
        "full_name": "no_match"
      }
    }
  ]
}
```

## Dados retornados

Os campos exatos expostos em `source_data` dependem do que o registro retorna. O exemplo gerado para `can_residential` documenta atualmente este formato normalizado:

* `address`
* `date_of_birth`
* `first_name`
* `last_name`

## Preços e SLAs

As consultas de Canada Residential são cobradas somente quando a Didit recebe um resultado conclusivo da fonte de validação.

* **Preço por chamada:** \$0.42 USD.
* **Faturamento:** por consulta bem-sucedida. Você não é cobrado quando o registro está inacessível, quando faltam campos obrigatórios ou quando a requisição é rejeitada antes de chegar à fonte.
* **Latência:** p95 típico \< 2 s.
* **Disponibilidade:** 99.9% por trimestre do lado da Didit; a disponibilidade da fonte externa varia por país e conjunto de dados.

## Continue a leitura

* [Visão geral da Validação de banco de dados do Canadá](https://docs.didit.me/api-reference/database-validation/canada.md)
* [Visão geral da Validação de banco de dados](https://docs.didit.me/pt-br/core-technology/database-validation/overview.md)
* [Códigos de resultado](https://docs.didit.me/pt-br/core-technology/database-validation/database-validation-outcome-codes.md)


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