Primeiros passos
Integração / SDKs
Verificação de usuários
Verificação de empresas
Monitoramento de transações
Registro de alteraçõescurl -X POST https://verification.didit.me/v3/database-validation/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"issuing_state": "BRA",
"services": ["bra_cpf"],
"identification_number": "12345678900",
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "1980-01-01",
"vendor_data": "user-1234"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.database_validation.validate(
issuing_state="BRA",
services=["bra_cpf"],
identification_number="12345678900",
first_name="John",
last_name="Doe",
date_of_birth="1980-01-01",
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: "BRA",
services: ["bra_cpf"],
identification_number: "12345678900",
first_name: "John",
last_name: "Doe",
date_of_birth: "1980-01-01",
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: "BRA",
Services: didit.Some([]string{"bra_cpf"}),
IdentificationNumber: didit.String("12345678900"),
FirstName: didit.String("John"),
LastName: didit.String("Doe"),
DateOfBirth: didit.String("1980-01-01"),
VendorData: didit.String("user-1234"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.time.LocalDate;
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("BRA")
.services(List.of("bra_cpf"))
.identificationNumber("12345678900")
.firstName("John")
.lastName("Doe")
.dateOfBirth(LocalDate.parse("1980-01-01"))
.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' => 'BRA',
'services' => ['bra_cpf'],
'identification_number' => '12345678900',
'first_name' => 'John',
'last_name' => 'Doe',
'date_of_birth' => '1980-01-01',
'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: "BRA",
services: ["bra_cpf"],
identification_number: "12345678900",
first_name: "John",
last_name: "Doe",
date_of_birth: "1980-01-01",
vendor_data: "user-1234"
)
puts result.to_husing 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 = "BRA",
Services = new string[] { "bra_cpf" },
IdentificationNumber = "12345678900",
FirstName = "John",
LastName = "Doe",
DateOfBirth = "1980-01-01",
VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));API de Validação de Base de Dados: Documento Nacional
Valide dados de identidade com a API da Didit em 100+ fontes nacionais e globais, com correspondência em cascata 1x1 e 2x2. Pague por chamada.
curl -X POST https://verification.didit.me/v3/database-validation/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"issuing_state": "BRA",
"services": ["bra_cpf"],
"identification_number": "12345678900",
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "1980-01-01",
"vendor_data": "user-1234"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.database_validation.validate(
issuing_state="BRA",
services=["bra_cpf"],
identification_number="12345678900",
first_name="John",
last_name="Doe",
date_of_birth="1980-01-01",
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: "BRA",
services: ["bra_cpf"],
identification_number: "12345678900",
first_name: "John",
last_name: "Doe",
date_of_birth: "1980-01-01",
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: "BRA",
Services: didit.Some([]string{"bra_cpf"}),
IdentificationNumber: didit.String("12345678900"),
FirstName: didit.String("John"),
LastName: didit.String("Doe"),
DateOfBirth: didit.String("1980-01-01"),
VendorData: didit.String("user-1234"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.time.LocalDate;
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("BRA")
.services(List.of("bra_cpf"))
.identificationNumber("12345678900")
.firstName("John")
.lastName("Doe")
.dateOfBirth(LocalDate.parse("1980-01-01"))
.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' => 'BRA',
'services' => ['bra_cpf'],
'identification_number' => '12345678900',
'first_name' => 'John',
'last_name' => 'Doe',
'date_of_birth' => '1980-01-01',
'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: "BRA",
services: ["bra_cpf"],
identification_number: "12345678900",
first_name: "John",
last_name: "Doe",
date_of_birth: "1980-01-01",
vendor_data: "user-1234"
)
puts result.to_husing 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 = "BRA",
Services = new string[] { "bra_cpf" },
IdentificationNumber = "12345678900",
FirstName = "John",
LastName = "Doe",
DateOfBirth = "1980-01-01",
VendorData = "user-1234",
});
Console.WriteLine(JsonSerializer.Serialize(result));Serviços baseados em endereço
Para serviços que validam um endereço residencial ou de serviço público, você pode enviar um únicoaddress e a Didit vai dividi-lo antes de processar a verificação. Para obter a melhor taxa de correspondência, envie diretamente os campos de endereço estruturados da Didit:
| Campo | Significado |
|---|---|
address_element_1 | Endereço, incluindo número e tipo de logradouro |
address_element_2 | Unidade, edifício, andar ou linha adicional de endereço (opcional) |
address_element_3 | Bairro, distrito, localidade ou vizinhança |
address_element_4 | Cidade, município, estado, província ou região |
address_element_5 | CEP ou código postal |
address. postal_code é aceito como alias de address_element_5.
Consentimento
Alguns serviços de banco de dados exigem o consentimento explícito do usuário final antes que o provedor possa ser consultado. O catálogo de serviços marca essas linhas comrequires_consent=true.
Envie consent=true quando o consentimento do usuário se aplicar aos serviços selecionados.
Se um serviço selecionado exigir consentimento e você não o enviar, a Didit rejeita a requisição antes de qualquer chamada ao provedor ou evento de faturamento.
Envio de arquivos
A validação de banco de dados usamultipart/form-data. Os serviços biométricos que exigem selfie exibem esse campo de envio de arquivo no playground da API, para que você possa selecionar uma imagem diretamente em vez de colar um caminho ou uma string base64.
No código, envie o arquivo com a sintaxe multipart padrão:
-F "selfie=@./selfie.jpg"
Erros de validação
A Didit valida os campos obrigatórios, a estrutura do endereço e os formatos específicos de cada serviço antes de chamar o provedor. Por exemplo, serviços de registro da China, comochn_national_id e chn_passport_verification, esperam full_name na escrita chinesa original, e chn_national_id também exige um documento nacional de identidade chinês válido, com 15 ou 18 caracteres e dígito verificador correto.
Se uma requisição não puder ser executada, a API retorna erros explícitos por campo e nenhum uso é faturado. Se um provedor falhar após a verificação prévia, a resposta inclui validation_errors, e as requisições de API salvas armazenam esses erros no resultado de validação no banco de dados.
Entrada rejeitada e resultados indisponíveis
Quando nenhum serviço retornar um resultado utilizável, inspecione cada entrada devalidation_errors antes de decidir se deve tentar novamente.
O status HTTP, por si só, não determina se é adequado tentar novamente.
Uma resposta 400 com code: "provider_rejected_input" e retryable: false significa que todas as tentativas sem resposta recusaram explicitamente a entrada.
Corrija os dados fornecidos antes de tentar novamente.
Essas tentativas não são faturadas.
Uma resposta 502 com code: "empty_provider_response" e retryable: true significa que o serviço não conseguiu produzir um resultado utilizável por outro motivo.
Isso inclui uma entrada recusada seguida de um fallback indisponível ou de um fallback que não fornece nenhuma explicação.
Tente novamente mais tarde; a resposta não comprova que a entrada está errada.
Se um banco de dados continuar falhando, a Didit envia um e-mail às organizações que o usaram recentemente quando a interrupção se prolonga, e outro quando verificações reais confirmam que ele voltou a responder. Consulte Notificações de disponibilidade.
Quando apenas alguns dos serviços selecionados falham, a requisição é bem-sucedida: a resposta é 200 e os serviços que falharam são listados em database_validation.errors[], cada um com os mesmos campos code e retryable.
Nesse caso, database_validation.status reflete os serviços que responderam e pode ser Approved; por isso, inspecione errors[] em todas as respostas, e não apenas em respostas 4xx ou 5xx.
Um serviço listado ali não aparece em validations nem em services_used e não é faturado; tente novamente apenas esse serviço.
Outros erros 502 podem exigir a correção da entrada.
Por exemplo, provider_invalid_input e provider_validation_error descrevem uma entrada que a fonte rejeitou, e você não deve tentar novamente sem alterá-la, mesmo quando a resposta legada omite retryable.
A orientação sobre tentar novamente para empty_provider_response não se aplica a esses códigos.
Um resultado conclusivo sem correspondência é uma verificação concluída, não uma falha de disponibilidade.Autorizações
Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.
Corpo
Código de país ISO 3166-1 alpha-3 do registro a ser usado na validação (por exemplo, BRA, ESP, COL). Determina quais serviços estão disponíveis. Códigos não suportados retornam 400 com a lista completa de opções válidas.
"BRA"
service_ids do catálogo a executar para este país (por exemplo, ["bra_cpf"]). Também aceita uma única string ou uma string separada por vírgulas ou codificada em JSON. Se omitido ou vazio, exatamente um serviço padrão é executado: o serviço ativo mais antigo do país; serviços mais novos, biométricos e com pagamento por uso devem ser indicados explicitamente. Enviar services muda a resposta para o formato estendido (adiciona services_used e match_score). Todo id deve existir e estar ativo para o issuing_state; serviços que exigem onboarding retornam 400 até serem ativados para a sua organização. Descubra os serviços disponíveis por país via GET /v1/organization/database-validation-countries/ (um endpoint de catálogo não documentado nesta especificação) ou no editor de fluxos do Business Console.
["bra_cpf"]
OBSOLETO. Aceito por compatibilidade com versões anteriores, mas ignorado: o validation_type da resposta agora é derivado de quantos serviços tiveram correspondência total. Use services para fixar serviços específicos.
Defina como true quando o usuário final tiver consentido explicitamente com os serviços de validação selecionados. Obrigatório para serviços marcados com requires_consent=true no catálogo; sem isso, esses serviços retornam 400 com services_requiring_consent.
Número de identificação universal, mapeado automaticamente para o campo específico do país correto, para que você possa usá-lo em vez de personal_number/tax_number/document_number: ARG→document_number (DNI), BOL→document_number (CI), BRA→tax_number (CPF, 11 dígitos), CHL→personal_number (RUT), COL→personal_number (Cédula), CRI→personal_number (Cédula), DOM→personal_number (Cédula, 11 dígitos), ECU→personal_number (Cédula, 10 dígitos), ESP→personal_number (DNI/NIE), GTM→document_number (DPI), HND→document_number (DNI), MEX→personal_number (CURP, 18 caracteres), PAN→personal_number (Cédula), PER→personal_number (DNI, 8 dígitos), PRY→document_number (CI), SLV→document_number (DUI), URY→personal_number (CI), VEN→document_number (Cédula). Ele nunca substitui um campo específico do país informado explicitamente.
O nome da pessoa física. Obrigatório para alguns serviços/países.
"John"
O sobrenome da pessoa física. Obrigatório para alguns serviços/países.
"Doe"
Nome do meio, usado por alguns serviços de países (AUS, NZL, …).
Nome completo. Alguns serviços aceitam este campo no lugar do nome e sobrenome (por exemplo, os serviços CHN, que fazem a correspondência com o nome na escrita nativa).
Data de nascimento, YYYY-MM-DD. Exigida por muitos serviços.
"1980-01-01"
Identificador pessoal único emitido pelo governo. Usado por: CHL (RUT), COL (Cédula), CRI, DOM, ECU, ESP (DNI/NIE), MEX (CURP), PAN (Cédula), PER (DNI), URY. Considere usar identification_number em vez disso.
Número de identificação fiscal. Usado por: BRA (CPF, 11 dígitos). Considere usar identification_number.
Número do documento. Usado por: ARG (DNI), BOL (CI), GTM (DPI), HND (DNI), PRY (CI), SLV (DUI), VEN (Cédula). Considere usar identification_number em vez dele.
Tipo de documento validado: P passaporte, DL carteira de motorista, ID documento nacional de identidade, RP autorização de residência (além de SSC, HIC, WP, TC, VISA, PSC, BC, OTHER). Exigido por alguns serviços (por exemplo, ESP).
P, DL, ID, RP, SSC, HIC, WP, TC, VISA, PSC, BC, OTHER Data de validade do documento, YYYY-MM-DD. Obrigatória para a validação ESP (Espanha).
"2030-01-15"
Data de emissão do documento, YYYY-MM-DD (fecha de expedición). Obrigatória para a validação da cédula COL (Colômbia).
"2015-06-20"
Nacionalidade no formato ISO 3166-1 alpha-3. Obrigatória para alguns serviços.
Gênero: M, F ou X (outro/desconhecido). Obrigatório para a validação RENAPER da Argentina (arg_renaper).
M, F, X Endereço residencial. Prefira o objeto estruturado {"street_1":"123 Main St","street_2":"Apt 4B","city":"Springfield","region":"IL","postal_code":"62701","country":"US"}; uma string completa em uma única linha ainda é aceita. Obrigatório para serviços de verificação de endereço; quando um serviço define requisitos de endereço, partes ausentes retornam 400 com address_fields_required_by.
Show child attributes
Show child attributes
Endereço incluindo número e tipo de logradouro. Se omitido, é derivado de address.
Apartamento, unidade, edifício, andar ou linha adicional do endereço. Envie apenas quando tiver essa informação explicitamente.
Cidade, subúrbio, distrito, localidade ou bairro. Se omitido, é derivado de address.
Estado, província, região ou cidade. Se omitido, é derivado de address.
CEP ou código postal. postal_code é aceito como alias.
Código postal para serviços baseados em endereço (alias de address_element_5).
Número da carteira de motorista para serviços governamentais de verificação de documentos (AUS, NZL, IND).
Número do cartão físico da carteira de motorista, quando exigido separadamente do número da carteira (AUS).
Estado ou território emissor da carteira de motorista (AUS).
Código de versão da carteira de motorista (NZL).
Número do passaporte para serviços governamentais de verificação de passaporte (AUS, NZL, IND, CHN).
Data de validade do passaporte, YYYY-MM-DD, para serviços de verificação de passaporte.
Número de arquivo do passaporte (IND).
País emissor do passaporte (ISO 3166-1 alpha-3) para serviços de verificação de passaporte.
Número do cartão Medicare (AUS).
Número do ImmiCard australiano.
Data de validade do ImmiCard australiano.
Número do certificado de cidadania (AUS).
Número de registro da certidão de nascimento (AUS).
Data de registro da certidão de nascimento (AUS).
Estado de registro da certidão de nascimento (AUS).
Número da certidão de casamento (AUS).
Número da certidão de mudança de nome (AUS).
Primeiro nome do cônjuge em uma certidão de casamento (AUS).
Sobrenome do cônjuge em uma certidão de casamento (AUS).
Número de registro eleitoral (IND EPIC, IRL).
Número do título de eleitor EPIC da Índia.
PAN (Permanent Account Number) da Índia.
Número de identidade nacional (CHN, MYS, KEN, KHM, NGA, ZAF, …).
Código de Identificación de Credencial (CIC) do INE/IFE mexicano, 9 dígitos. Usado pelo serviço de validade da credencial INE do México (mex_ine_vigencia).
Identificador del Ciudadano do INE mexicano (9 dígitos). Usado com cic para os modelos modernos do INE (E/F/G/H) em mex_ine_vigencia.
Número OCR do INE mexicano (13 dígitos, no verso do cartão). Usado com cic para o Modelo D em mex_ine_vigencia.
Clave de Elector do INE mexicano (18 caracteres). Usada com emission_number para os modelos antigos do IFE (A/B/C) em mex_ine_vigencia.
Número de Emisión do INE mexicano. Usado com voter_number para os modelos antigos do IFE (A/B/C) em mex_ine_vigencia.
Bank Verification Number (BVN) da Nigéria.
Número do cartão bancário (verificação de cartão bancário da CHN).
Número de registro da empresa emitido pelo registro de empresas: o CNPJ no Brasil (por exemplo, 11222333000181), o número de registro na África do Sul (por exemplo, 1936/007721/06). Obrigatório para os serviços de registro de empresas e de diretores de empresas (bra_company_registry, bra_company_directors, zaf_company_registry, zaf_company_directors).
Razão social registrada, verificada em relação ao registro. Opcional para zaf_company_registry.
As iniciais da pessoa conforme impressas no documento. Obrigatório para zaf_drivers_license; aceito por zaf_bank_account_holder.
Número da carteira de motorista conforme impresso no cartão, para zaf_drivers_license. Quando omitido, é usado o document_number.
Número do processo de refugiado emitido pelo Department of Home Affairs da África do Sul. Obrigatório para zaf_refugee.
Nome do banco que mantém a conta. Obrigatório para zaf_bank_account_holder.
Número da conta bancária. Obrigatório para zaf_bank_account_holder; aceito por zaf_fraud_prevention.
Tipo de conta bancária para zaf_bank_account_holder: current, savings, transmission, subscriptionShare ou notKnown, sem diferenciar maiúsculas de minúsculas. Qualquer outro valor retorna 400. Omita-o quando não souber o tipo: nesse caso, a verificação cruzada do tipo de conta é reportada como não confirmada.
Número de celular de contato, para os serviços que verificam a contactabilidade (zaf_bank_account_holder, zaf_fraud_prevention, zaf_refugee).
Impressão digital do polegar direito codificada em Base64 para zaf_dha_fingerprint_match, junto com left_thumb ou sozinha.
Impressão digital do polegar esquerdo codificada em Base64 para zaf_dha_fingerprint_match, junto com right_thumb ou sozinha.
Nível mínimo de pontuação biométrica para zaf_criminal_face_screening. O padrão é 3.
Número máximo de correspondências candidatas que zaf_criminal_face_screening retorna. O padrão é 1.
Número de registro do veículo. Obrigatório, junto com vehicle_licence_plate e vin, para zaf_vehicle_ownership.
Número da placa do veículo. Obrigatório, junto com vehicle_register_number e vin, para zaf_vehicle_ownership.
Número de identificação do veículo (VIN ou número do chassi). Obrigatório, junto com vehicle_register_number e vehicle_licence_plate, para zaf_vehicle_ownership.
Número do Seguro Social (Social Security Number, EUA).
Número de telefone para serviços de verificação de telefone.
Número de telefone fixo para serviços de verificação de telefone.
Endereço de e-mail para serviços de verificação de identidade.
País de residência em ISO 3166-1 alpha-2. Usado por serviços globais de enriquecimento de identidade (por exemplo, glb_identity_enrichment) para direcionar a consulta.
"US"
O efeito de um partial_match em database_validation.status. O padrão é NO_ACTION (o status permanece Approved, com um aviso).
DECLINE, NO_ACTION O efeito de um no_match em database_validation.status. O padrão é DECLINE.
DECLINE, NO_ACTION Persiste a validação como uma sessão (visibilidade no console, endpoint de decisão, webhook status.updated). Também altera o formato da resposta validations: objetos por serviço quando true (padrão), um mapa de campos mesclado quando false.
Seu identificador para o usuário validado; retornado na resposta e armazenado com a sessão.
JSON livre armazenado com a requisição e retornado na resposta.
Resposta
Validação concluída: pelo menos um serviço selecionado retornou um resultado utilizável. Consulte database_validation.match_type para o resultado agregado, validations para as comparações de campos por serviço e os outcome_codes, e errors (quando presente) para os serviços que falharam.
ID da sessão persistida quando save_api_request=true (utilizável com GET /v3/session/{sessionId}/decision/); caso contrário, um UUID de correlação transitório.
Show child attributes
Show child attributes
Eco dos vendor_data que você enviou.
Eco do metadata que você enviou.