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"
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)
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);
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)
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
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());
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
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));
{
"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"
}
}
]
}
{
"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"
}
}
]
}
{
"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"
}
}
]
}
🇨🇦 Canada
API Canada résidentiel : correspondance d'identité
Validation Canada en base de données résidentielle via l’infrastructure d’identité de Didit. À partir de $0.42 par appel, sans contrat ni minimum.
POST
/
v3
/
database-validation
/
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"
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)
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);
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)
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
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());
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
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));
{
"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"
}
}
]
}
{
"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"
}
}
]
}
{
"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"
}
}
]
}
Vérifie les données saisies par rapport aux données téléphoniques des opérateurs de réseaux mobiles. Une demande auprès d’une agence est requise. Didit expose ce service via
POST /v3/database-validation/ afin que vous puissiez vérifier les données soumises auprès de la source faisant autorité et recevoir des résultats de correspondance normalisés.
Couverture
- Couverture : ~ 90%
- Pays : Canada
- ID du service :
can_residential - Domaine de données : Adresse
- Catégorie : Résidentiel
Entrées
| Champ | Requis | Exemple |
|---|---|---|
first_name | Oui | John |
last_name | Oui | Doe |
address.street_1 | Oui | 123 Sample Street |
address.postal_code | Oui | 10001 |
phone | Oui | +15550101000 |
date_of_birth | Non | 1990-01-01 |
address.street_2 | Non | Unit 4 |
address.city | Non | Sample City |
address.region | Non | Sample State |
vendor_data | Non | user-1234 |
- Entrées obligatoires :
first_name,last_name,address.street_1,address.postal_code,phone - Entrées facultatives :
date_of_birth,address.street_2,address.city,address.region,vendor_data - Consentement : Requis
- Disponibilité dans le workflow : Disponible dans le workflow
- Couverture : ~ 90%
- Prix : $0.42 par requête réussie
Paramètres du corps de requête
string
défaut:"CAN"
requis
Code pays ISO 3166-1 alpha-3 de ce service de base de données.Exemple :
CANstring
défaut:"can_residential"
requis
Tableau contenant l’ID de ce service. Épingler le service limite la requête à cette base de données précise.Exemple :
can_residentialboolean
défaut:"true"
requis
Consentement explicite de l’utilisateur final pour ce service.Exemple :
truestring
défaut:"John"
requis
Prénom à valider.Exemple :
Johnstring
défaut:"Doe"
requis
Nom de famille à valider.Exemple :
Doeobject
requis
Objet d’adresse résidentielle structuré. Utilisez
street_1, street_2, city, region, postal_code et country. Une chaîne d’adresse complète au format historique est toujours acceptée, mais déconseillée.Exemple : {"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}string
défaut:"+15550101000"
requis
Numéro de téléphone au format international.Exemple :
+15550101000string
Date de naissance au format
YYYY-MM-DD.Exemple : 1990-01-01string
défaut:"user-1234"
Votre référence utilisateur stable pour cette personne, par exemple votre identifiant interne d’utilisateur. Didit s’en sert pour relier les vérifications autonomes au même utilisateur final et réduire le bruit des détections de doublons.Exemple :
user-1234Règles de saisie et notes de validation
- Pour les services fondés sur l’adresse, envoyez les champs d’adresse structurés plutôt qu’une seule chaîne
addresslorsque c’est possible. address.street_1correspond à l’adresse de rue, avec le numéro et le type de voie.address.street_2correspond à l’appartement, à l’unité, au bâtiment, à l’étage ou à une ligne d’adresse supplémentaire. Ne l’envoyez que si vous en disposez.address.citycorrespond à la ville, à la banlieue, au district, à la localité ou au quartier.address.regioncorrespond à l’État, à la province, à la région ou à la commune.address.postal_codecorrespond au code postal.- Les services de base de données fondés sur l’adresse exigent au minimum l’adresse de rue et le code postal ; les requêtes rejetées avant la recherche dans la source ne sont pas facturées.
Comment l’appeler
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"
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)
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);
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)
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
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());
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
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));
Chaque appel réussi renvoie HTTP 200. Le champ outcome_code indique ce qui s’est réellement passé, en distinguant par exemple une véritable non-correspondance biométrique (BIOMETRIC_NO_MATCH) d’un selfie illisible (BIOMETRIC_IMAGE_UNUSABLE). Le status affiché est le statut par défaut de la fonctionnalité ; vos actions de correspondance partielle / d’absence de correspondance configurées peuvent le remplacer.MATCH : Le registre a confirmé l’identité, et chaque champ vérifié correspond.{
"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 : Un ou plusieurs champs comparés par ce service ne correspondent pas entièrement. Dans cet exemple, full_name ne correspond pas, tandis que address correspond.{
"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 : Le registre n’a renvoyé aucune correspondance pour les données soumises.{
"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"
}
}
]
}
Données renvoyées
Les champs exacts exposés danssource_data dépendent de ce que renvoie le registre. L’exemple généré pour can_residential documente actuellement la structure normalisée suivante :
addressdate_of_birthfirst_namelast_name
Tarifs et SLA
Les requêtes Canada Residential ne sont facturées que lorsque Didit reçoit un résultat concluant de la source de validation.- Prix par appel : $0.42 USD.
- Facturation : par requête réussie. Vous n’êtes pas facturé lorsque le registre est injoignable, lorsque des champs obligatoires sont manquants ou lorsque la requête est rejetée avant d’atteindre la source.
- Latence : p95 typique inférieure à 2 s.
- Disponibilité : 99.9 % par trimestre côté Didit ; la disponibilité de la source en aval varie selon le pays et le jeu de données.
Pour aller plus loin
Dernière modification le 7 novembre 2026