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/id-verification/' \
-H 'x-api-key: YOUR_API_KEY' \
-F 'front_image=@./id_front.jpg' \
-F 'back_image=@./id_back.jpg' \
-F 'perform_document_liveness=true' \
-F 'save_api_request=true' \
-F 'vendor_data=user-123'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.id_verification.verify(
front_image=open("front_image.jpg", "rb"),
back_image=open("back_image.jpg", "rb"),
perform_document_liveness=True,
save_api_request=True,
vendor_data="user-123",
metadata={"flow": "onboarding"},
)
print(result)import Didit, { fileFromPath } from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.idVerification.verify({
front_image: await fileFromPath("front_image.jpg"),
back_image: await fileFromPath("back_image.jpg"),
perform_document_liveness: true,
save_api_request: true,
vendor_data: "user-123",
metadata: { flow: "onboarding" },
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.IDVerification.Verify(ctx, didit.IDVerificationVerifyParams{
FrontImage: didit.FileFromPath("front_image.jpg"),
BackImage: didit.Some(didit.FileFromPath("back_image.jpg")),
PerformDocumentLiveness: didit.Bool(true),
SaveAPIRequest: didit.Bool(true),
VendorData: didit.String("user-123"),
Metadata: didit.Some(map[string]any{"flow": "onboarding"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.nio.file.Path;
import java.util.Map;
import me.didit.Didit;
import me.didit.types.IdVerificationVerifyParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.idVerification().verify(IdVerificationVerifyParams.builder()
.frontImage(Path.of("front_image.jpg"))
.backImage(Path.of("back_image.jpg"))
.performDocumentLiveness(true)
.saveApiRequest(true)
.vendorData("user-123")
.metadata(Map.of("flow", "onboarding"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
use Didit\File;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->idVerification->verify([
'front_image' => File::fromPath('front_image.jpg'),
'back_image' => File::fromPath('back_image.jpg'),
'perform_document_liveness' => true,
'save_api_request' => true,
'vendor_data' => 'user-123',
'metadata' => ['flow' => 'onboarding'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.id_verification.verify(
front_image: Pathname("front_image.jpg"),
back_image: Pathname("back_image.jpg"),
perform_document_liveness: true,
save_api_request: true,
vendor_data: "user-123",
metadata: { flow: "onboarding" }
)
puts result.to_husing System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.IdVerification.VerifyAsync(new IdVerificationVerifyParams
{
FrontImage = FileUpload.FromPath("front_image.jpg"),
BackImage = FileUpload.FromPath("back_image.jpg"),
PerformDocumentLiveness = true,
SaveApiRequest = true,
VendorData = "user-123",
Metadata = new Dictionary<string, object> { ["flow"] = "onboarding" },
});
Console.WriteLine(JsonSerializer.Serialize(result));API de Verificação de ID: OCR e Autenticidade
Didit verifica documentos de identidade de 220+ países e 14.000+ tipos: autenticidade, OCR, MRZ, inferência sub-2s, pague por uso, sem contrato.
curl -X POST 'https://verification.didit.me/v3/id-verification/' \
-H 'x-api-key: YOUR_API_KEY' \
-F 'front_image=@./id_front.jpg' \
-F 'back_image=@./id_back.jpg' \
-F 'perform_document_liveness=true' \
-F 'save_api_request=true' \
-F 'vendor_data=user-123'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.id_verification.verify(
front_image=open("front_image.jpg", "rb"),
back_image=open("back_image.jpg", "rb"),
perform_document_liveness=True,
save_api_request=True,
vendor_data="user-123",
metadata={"flow": "onboarding"},
)
print(result)import Didit, { fileFromPath } from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.idVerification.verify({
front_image: await fileFromPath("front_image.jpg"),
back_image: await fileFromPath("back_image.jpg"),
perform_document_liveness: true,
save_api_request: true,
vendor_data: "user-123",
metadata: { flow: "onboarding" },
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.IDVerification.Verify(ctx, didit.IDVerificationVerifyParams{
FrontImage: didit.FileFromPath("front_image.jpg"),
BackImage: didit.Some(didit.FileFromPath("back_image.jpg")),
PerformDocumentLiveness: didit.Bool(true),
SaveAPIRequest: didit.Bool(true),
VendorData: didit.String("user-123"),
Metadata: didit.Some(map[string]any{"flow": "onboarding"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.nio.file.Path;
import java.util.Map;
import me.didit.Didit;
import me.didit.types.IdVerificationVerifyParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.idVerification().verify(IdVerificationVerifyParams.builder()
.frontImage(Path.of("front_image.jpg"))
.backImage(Path.of("back_image.jpg"))
.performDocumentLiveness(true)
.saveApiRequest(true)
.vendorData("user-123")
.metadata(Map.of("flow", "onboarding"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
use Didit\File;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->idVerification->verify([
'front_image' => File::fromPath('front_image.jpg'),
'back_image' => File::fromPath('back_image.jpg'),
'perform_document_liveness' => true,
'save_api_request' => true,
'vendor_data' => 'user-123',
'metadata' => ['flow' => 'onboarding'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.id_verification.verify(
front_image: Pathname("front_image.jpg"),
back_image: Pathname("back_image.jpg"),
perform_document_liveness: true,
save_api_request: true,
vendor_data: "user-123",
metadata: { flow: "onboarding" }
)
puts result.to_husing System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.IdVerification.VerifyAsync(new IdVerificationVerifyParams
{
FrontImage = FileUpload.FromPath("front_image.jpg"),
BackImage = FileUpload.FromPath("back_image.jpg"),
PerformDocumentLiveness = true,
SaveApiRequest = true,
VendorData = "user-123",
Metadata = new Dictionary<string, object> { ["flow"] = "onboarding" },
});
Console.WriteLine(JsonSerializer.Serialize(result));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
Frente do documento de identidade. Extensões permitidas: tiff, jpg, jpeg, png, webp, pdf. Tamanho máximo de upload: 10 MB (arquivos maiores são rejeitados com 400). PDFs são renderizados como imagem antes do OCR; PDFs criptografados exigem front_image_password. As imagens são comprimidas automaticamente para ~0,5 MB e a orientação EXIF é aplicada. Envie a captura completa, sem recorte, com os quatro cantos do documento visíveis.
Senha para descriptografar front_image quando for um PDF criptografado. Enviar um PDF criptografado sem senha (ou com uma senha errada) retorna 400.
Verso do documento: envie-o sempre que o documento tiver um (muitas carteiras de identidade trazem a MRZ ou um código de barras no verso; omiti-lo apenas deixa a MRZ e os campos do verso vazios na resposta, e este endpoint não gera um aviso de MRZ ausente). Mesmo formato e limites de tamanho de front_image. Quando omitido, back_image e os campos do verso são null na resposta.
Senha para descriptografar back_image quando for um PDF criptografado.
Analisa as duas imagens em busca de fraude de apresentação: reprodução em tela (SCREEN_CAPTURE_DETECTED), cópias impressas (PRINTED_COPY_DETECTED) e manipulação do retrato (PORTRAIT_MANIPULATION_DETECTED). Qualquer uma delas resulta em recusa automática. Ativado por padrão; defina como false para pular a análise de fraude e reduzir a latência. Quando ativado e o provedor não retorna uma pontuação utilizável, a resposta é In Review com um aviso DOCUMENT_LIVENESS_NOT_COMPUTED, em vez de Approved.
true
Aceito e validado (1–120), mas atualmente não aplicado por este endpoint — ele nunca gera um aviso MINIMUM_AGE_NOT_MET a partir deste campo. Aplique as regras de idade com base em date_of_birth/age retornados, ou use um fluxo de sessão de verificação com restrições de idade.
1 <= x <= 120O que fazer quando nenhuma data de validade pode ser lida (EXPIRATION_DATE_NOT_DETECTED). Padrão NO_ACTION, pois muitos documentos de identidade não trazem data de validade impressa. Observação: uma data de validade detectada e já vencida sempre recusa (DOCUMENT_EXPIRED), independentemente desta opção.
NO_ACTION, DECLINE O que fazer quando a MRZ extraída falha na validação dos dígitos verificadores (MRZ_VALIDATION_FAILED). A ausência de MRZ não gera aviso neste endpoint. Relevante apenas para documentos que possuem MRZ. REVIEW não é compatível com este endpoint e retorna 400.
NO_ACTION, DECLINE O que fazer quando os dados extraídos são internamente inconsistentes: DATA_INCONSISTENT, MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME (a zona visual diverge da MRZ) ou DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS.
NO_ACTION, DECLINE O que fazer quando um campo impresso crítico foi fisicamente coberto na captura (CRITICAL_FIELD_OCCLUSION_DETECTED): um número de identidade, um nome, a data de nascimento ou a data de validade. Recusa por padrão, como os demais riscos de integridade de documento deste endpoint: cobrir os números com os quais um relatório é conciliado é justamente a aparência de um documento censurado. O valor lido de um campo coberto é descartado da extração de qualquer forma, então o aviso *_NOT_DETECTED correspondente geralmente o acompanha. REVIEW não é compatível com este endpoint e retorna 400.
NO_ACTION, DECLINE O que fazer quando um número não corresponde ao formato que a autoridade emissora usa para aquele tipo de documento (DOCUMENT_NUMBER_FORMAT_MISMATCH, PERSONAL_NUMBER_FORMAT_MISMATCH). Padrão NO_ACTION, que informa o aviso sem alterar o status. REVIEW não é compatível com este endpoint e retorna 400.
NO_ACTION, DECLINE Escrita preferencial para os campos de nome/endereço em documentos que imprimem texto latino e não latino (árabe, cirílico, CJK, …). latin retorna valores transliterados/latinos; non_latin dá preferência à escrita nativa.
latin, non_latin Quando true (padrão), persiste a chamada como uma sessão do tipo API: visível no Business Console, recuperável via GET /v3/session/{sessionId}/decision/ usando o request_id retornado, anunciada por meio de um webhook status.updated e com as imagens do documento retornadas como URLs de mídia. Quando false, nada é armazenado, request_id é um UUID transitório e as imagens são retornadas inline como strings JPEG em base64.
true
String opaca opcional (seu ID interno de usuário, e-mail, UUID…) armazenada na sessão persistida e devolvida na resposta. Use-a para correlacionar chamadas de API com seus próprios registros e para filtrar sessões posteriormente.
"user-123"
Objeto JSON opcional armazenado com a sessão (quando save_api_request=true) e devolvido na resposta. Em requisições multipart, envie-o como um campo de string codificada em JSON (por exemplo, metadata={"flow":"onboarding"}), que é convertido em um objeto.
{ "flow": "onboarding" }
Resposta
Documento processado. id_verification.status é Approved, Declined ou In Review; cada problema detectado é detalhado em id_verification.warnings. In Review é retornado quando uma verificação de prova de vida do documento solicitada não produziu resultado utilizável (DOCUMENT_LIVENESS_NOT_COMPUTED). Um documento com problemas ainda retorna 200 com status: "Declined": inspecione o corpo, não apenas o código HTTP. Quando save_api_request=true, request_id é o id da sessão persistida e os campos de imagem são URLs de mídia de curta duração; com save_api_request=false, eles são strings JPEG em base64 inline.
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 do vendor_data que você enviou, ou null.
Eco do objeto metadata que você enviou, ou null.
Timestamp ISO 8601 (UTC) do momento em que a resposta foi gerada.