Começar
Integrar / SDKs
Verificação de utilizadores
Verificação de empresas
Monitorização de transações
Registo 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));{
"request_id": "11d219ed-d59c-4b1d-8d65-9b933f12d5b8",
"id_verification": {
"status": "Approved",
"document_type": "Identity Card",
"document_subtype": "ID_CARD_GENERIC",
"document_number": "CBX164224",
"personal_number": "20446581H",
"portrait_image": "https://<media-host>/ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-portrait_image-8c2f.jpg?signature=...",
"front_image": "https://<media-host>/ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-front_image-4a1e.jpg?signature=...",
"back_image": "https://<media-host>/ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-back_image-77b0.jpg?signature=...",
"front_image_camera_front": null,
"back_image_camera_front": null,
"front_image_camera_front_face_match_score": null,
"back_image_camera_front_face_match_score": null,
"front_image_quality_score": {
"focus_score": 78,
"brightness_score": 83.2,
"brightness_issue": "ok",
"is_document_fully_visible": true,
"resolution_score": 40.7,
"overall_score": 70.2
},
"back_image_quality_score": {
"focus_score": 100,
"brightness_score": 95.6,
"brightness_issue": "ok",
"is_document_fully_visible": true,
"resolution_score": 43,
"overall_score": 84.4
},
"date_of_birth": "1980-01-13",
"age": 46,
"expiration_date": "2032-03-31",
"date_of_issue": "2022-03-31",
"issuing_state": "ESP",
"issuing_state_name": "Spain",
"first_name": "Julio Francisco",
"last_name": "Fores Sena",
"full_name": "Julio Francisco Fores Sena",
"gender": "M",
"address": "Brda. Urb. El Cardonal 0052 52 Po3 B,Taco,San Cristobal De La Laguna,Santa Cruz De Tenerife",
"formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain",
"place_of_birth": "Valencia, Valencia",
"marital_status": "UNKNOWN",
"nationality": "ESP",
"extra_fields": {
"first_surname": "Fores",
"second_surname": "Sena"
},
"mrz": {
"surname": "FORES SENA",
"name": "JULIO FRANCISCO",
"country": "ESP",
"nationality": "ESP",
"birth_date": "800113",
"expiry_date": "320331",
"sex": "M",
"document_type": "ID",
"document_number": "CBX164224",
"optional_data": "20446581H",
"optional_data_2": "",
"birth_date_hash": "9",
"expiry_date_hash": "8",
"document_number_hash": "3",
"final_hash": "3",
"personal_number": "20446581H",
"warnings": [],
"errors": [],
"mrz_type": "TD1",
"mrz_string": "IDESPCBX164224320446581H<<<<<<\n8001139M3203318ESP<<<<<<<<<<<3\nFORES<SENA<<JULIO<FRANCISCO<<<",
"mrz_key": "CBX164224380011393203318"
},
"parsed_address": {
"street_1": "Avenida el Cardonal 52",
"street_2": "b",
"city": "La Laguna",
"region": "Canarias",
"country": "ES",
"postal_code": "38108",
"address_type": "Avenida",
"formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain",
"raw_results": {
"address_components": [
{
"long_name": "b",
"short_name": "b",
"types": [
"subpremise"
]
},
{
"long_name": "52",
"short_name": "52",
"types": [
"street_number"
]
},
{
"long_name": "Avenida el Cardonal",
"short_name": "Av. el Cardonal",
"types": [
"route"
]
},
{
"long_name": "La Laguna",
"short_name": "La Laguna",
"types": [
"locality",
"political"
]
},
{
"long_name": "Spain",
"short_name": "ES",
"types": [
"country",
"political"
]
},
{
"long_name": "38108",
"short_name": "38108",
"types": [
"postal_code"
]
}
],
"formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain",
"geometry": {
"location": {
"lat": 28.4501161,
"lng": -16.3004407
},
"location_type": "ROOFTOP"
},
"types": [
"street_address",
"subpremise"
]
},
"document_location": {
"latitude": 28.4501161,
"longitude": -16.3004407
},
"label": "Spain Identity Card Address",
"is_verified": true,
"category": "Residential"
},
"warnings": [],
"barcodes": []
},
"vendor_data": "user-123",
"metadata": {
"flow": "onboarding"
},
"created_at": "2026-06-12T02:21:56.013573+00:00"
}API de verificação de identidade: OCR e autenticidade
Verifique documentos de identidade em 220+ países e 14,000+ tipos com a Didit. OCR, MRZ, autenticidade, pago por utilização e sem contratos.
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));{
"request_id": "11d219ed-d59c-4b1d-8d65-9b933f12d5b8",
"id_verification": {
"status": "Approved",
"document_type": "Identity Card",
"document_subtype": "ID_CARD_GENERIC",
"document_number": "CBX164224",
"personal_number": "20446581H",
"portrait_image": "https://<media-host>/ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-portrait_image-8c2f.jpg?signature=...",
"front_image": "https://<media-host>/ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-front_image-4a1e.jpg?signature=...",
"back_image": "https://<media-host>/ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-back_image-77b0.jpg?signature=...",
"front_image_camera_front": null,
"back_image_camera_front": null,
"front_image_camera_front_face_match_score": null,
"back_image_camera_front_face_match_score": null,
"front_image_quality_score": {
"focus_score": 78,
"brightness_score": 83.2,
"brightness_issue": "ok",
"is_document_fully_visible": true,
"resolution_score": 40.7,
"overall_score": 70.2
},
"back_image_quality_score": {
"focus_score": 100,
"brightness_score": 95.6,
"brightness_issue": "ok",
"is_document_fully_visible": true,
"resolution_score": 43,
"overall_score": 84.4
},
"date_of_birth": "1980-01-13",
"age": 46,
"expiration_date": "2032-03-31",
"date_of_issue": "2022-03-31",
"issuing_state": "ESP",
"issuing_state_name": "Spain",
"first_name": "Julio Francisco",
"last_name": "Fores Sena",
"full_name": "Julio Francisco Fores Sena",
"gender": "M",
"address": "Brda. Urb. El Cardonal 0052 52 Po3 B,Taco,San Cristobal De La Laguna,Santa Cruz De Tenerife",
"formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain",
"place_of_birth": "Valencia, Valencia",
"marital_status": "UNKNOWN",
"nationality": "ESP",
"extra_fields": {
"first_surname": "Fores",
"second_surname": "Sena"
},
"mrz": {
"surname": "FORES SENA",
"name": "JULIO FRANCISCO",
"country": "ESP",
"nationality": "ESP",
"birth_date": "800113",
"expiry_date": "320331",
"sex": "M",
"document_type": "ID",
"document_number": "CBX164224",
"optional_data": "20446581H",
"optional_data_2": "",
"birth_date_hash": "9",
"expiry_date_hash": "8",
"document_number_hash": "3",
"final_hash": "3",
"personal_number": "20446581H",
"warnings": [],
"errors": [],
"mrz_type": "TD1",
"mrz_string": "IDESPCBX164224320446581H<<<<<<\n8001139M3203318ESP<<<<<<<<<<<3\nFORES<SENA<<JULIO<FRANCISCO<<<",
"mrz_key": "CBX164224380011393203318"
},
"parsed_address": {
"street_1": "Avenida el Cardonal 52",
"street_2": "b",
"city": "La Laguna",
"region": "Canarias",
"country": "ES",
"postal_code": "38108",
"address_type": "Avenida",
"formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain",
"raw_results": {
"address_components": [
{
"long_name": "b",
"short_name": "b",
"types": [
"subpremise"
]
},
{
"long_name": "52",
"short_name": "52",
"types": [
"street_number"
]
},
{
"long_name": "Avenida el Cardonal",
"short_name": "Av. el Cardonal",
"types": [
"route"
]
},
{
"long_name": "La Laguna",
"short_name": "La Laguna",
"types": [
"locality",
"political"
]
},
{
"long_name": "Spain",
"short_name": "ES",
"types": [
"country",
"political"
]
},
{
"long_name": "38108",
"short_name": "38108",
"types": [
"postal_code"
]
}
],
"formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain",
"geometry": {
"location": {
"lat": 28.4501161,
"lng": -16.3004407
},
"location_type": "ROOFTOP"
},
"types": [
"street_address",
"subpremise"
]
},
"document_location": {
"latitude": 28.4501161,
"longitude": -16.3004407
},
"label": "Spain Identity Card Address",
"is_verified": true,
"category": "Residential"
},
"warnings": [],
"barcodes": []
},
"vendor_data": "user-123",
"metadata": {
"flow": "onboarding"
},
"created_at": "2026-06-12T02:21:56.013573+00:00"
}Autorizações
A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.
Corpo
Frente do documento de identificação. Extensões permitidas: tiff, jpg, jpeg, png, webp, pdf. Tamanho máximo de carregamento: 10 MB (ficheiros maiores são rejeitados com 400). Os PDFs são convertidos numa imagem antes do OCR; PDFs encriptados requerem front_image_password. As imagens são comprimidas automaticamente para ~0.5 MB e a orientação EXIF é aplicada. Carregue a captura completa e sem cortes com os quatro cantos do documento visíveis.
Palavra-passe para desencriptar front_image quando for um PDF encriptado. O envio de um PDF encriptado sem palavra-passe (ou com uma incorreta) devolve 400.
Verso do documento — envie-o sempre que o documento tiver um (muitos cartões de identificação contêm o MRZ ou um código de barras no verso; omiti-lo apenas deixa o MRZ e os campos do verso vazios na resposta — este endpoint não gera um aviso de MRZ em falta). Mesmos limites de formato e tamanho que front_image. Quando omitido, back_image e os campos do verso ficam a null na resposta.
Palavra-passe para desencriptar back_image quando for um PDF encriptado.
Analisa ambas as imagens à procura de fraude de apresentação: reproduções de ecrã (SCREEN_CAPTURE_DETECTED), cópias impressas (PRINTED_COPY_DETECTED) e manipulação de retrato (PORTRAIT_MANIPULATION_DETECTED). Qualquer uma destas situações causa recusa automática. Ativado por predefinição; defina como false para ignorar a triagem de fraude e reduzir a latência. Quando ativado e o fornecedor não devolve uma pontuação utilizável, a resposta é In Review com um aviso DOCUMENT_LIVENESS_NOT_COMPUTED em vez de Approved.
true
Aceite e validado (1–120), mas atualmente não aplicado por este endpoint — nunca produz um aviso MINIMUM_AGE_NOT_MET a partir deste campo. Aplique regras de idade a partir de date_of_birth/age devolvidos, ou utilize um fluxo de sessão de verificação com restrições de idade.
1 <= x <= 120O que fazer quando não for possível ler qualquer data de validade (EXPIRATION_DATE_NOT_DETECTED). Predefinição NO_ACTION, pois muitos documentos de identidade não imprimem a data de validade. Nota: uma data de validade detetada e ultrapassada resulta sempre numa recusa (DOCUMENT_EXPIRED), independentemente desta opção.
NO_ACTION, DECLINE O que fazer quando a MRZ extraída falha na validação do dígito de controlo (MRZ_VALIDATION_FAILED). Uma MRZ em falta não gera qualquer aviso neste endpoint. Relevante apenas para documentos que possuem uma MRZ. REVIEW não é suportado neste endpoint e devolve 400.
NO_ACTION, DECLINE O que fazer quando os dados extraídos forem internamente inconsistentes: DATA_INCONSISTENT, MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME (a zona visual não coincide com a MRZ) ou DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS.
NO_ACTION, DECLINE O que fazer quando um campo impresso crítico foi fisicamente tapado na captura (CRITICAL_FIELD_OCCLUSION_DETECTED) - um número de identificação, um nome, a data de nascimento ou a data de validade. Recusa por predefinição, tal como outros riscos de integridade do documento deste endpoint: tapar os números face aos quais um relatório é reconciliado é o aspeto típico de um documento rasurado. O valor lido para um campo tapado é descartado da extração de qualquer forma, pelo que o aviso *_NOT_DETECTED correspondente costuma acompanhá-lo. O valor REVIEW não é suportado neste endpoint e devolve 400.
NO_ACTION, DECLINE O que fazer quando um número não corresponder ao formato que a sua autoridade emissora utiliza para esse tipo de documento (DOCUMENT_NUMBER_FORMAT_MISMATCH, PERSONAL_NUMBER_FORMAT_MISMATCH). Predefinição NO_ACTION, que comunica o aviso sem alterar o estado. O valor REVIEW não é suportado neste endpoint e devolve 400.
NO_ACTION, DECLINE Sistema de escrita preferencial para os campos de nome/morada em documentos que imprimem texto latino e não latino (árabe, cirílico, CJK, …). latin devolve valores transliterados/latinos; non_latin prefere o sistema de escrita nativo.
latin, non_latin Quando for true (predefinição), persiste a chamada como uma sessão do tipo API — visível na Business Console, recuperável através de GET /v3/session/{sessionId}/decision/ utilizando o request_id devolvido, anunciada através de um webhook status.updated e com imagens de documentos devolvidas como URLs de multimédia. Quando for false, nada é armazenado, request_id é um UUID transitório e as imagens são devolvidas em linha como strings JPEG em base64.
true
String opaca opcional (o seu ID de utilizador interno, e-mail, UUID...) guardada na sessão persistida e devolvida na resposta. Utilize-a para correlacionar chamadas de API com os seus próprios registos e para filtrar sessões mais tarde.
"user-123"
Objeto JSON opcional armazenado com a sessão (quando save_api_request=true) e devolvido na resposta. Em pedidos multipart, envie-o como um campo de texto codificado em JSON (por exemplo, metadata={"flow":"onboarding"}) — é convertido num objeto.
{ "flow": "onboarding" }
Resposta
Documento processado. id_verification.status é Approved, Declined ou In Review; cada problema detetado é discriminado em id_verification.warnings. In Review é devolvido quando uma verificação de prova de vida no documento solicitada não produziu nenhum resultado utilizável (DOCUMENT_LIVENESS_NOT_COMPUTED). Um documento com problemas continua a devolver 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 multimédia de curta duração; com save_api_request=false, são strings JPEG 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 enviou, ou null.
Eco do objeto metadata que enviou, ou null.
Carimbo de data/hora ISO 8601 (UTC) de quando a resposta foi gerada.