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/poa/' \
-H 'x-api-key: YOUR_API_KEY' \
-F 'document=@./utility-bill.pdf' \
-F 'expected_address=Av. Monseñor Tavella 1291, Salta, Argentina' \
-F 'expected_country=ARG' \
-F 'expected_first_name=Sophia' \
-F 'expected_last_name=Martinez' \
-F 'poa_languages_allowed=en,es' \
-F 'vendor_data=user-123' \
--max-time 45from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.proof_of_address.verify(
document=open("document.pdf", "rb"),
expected_address="Av. Monseñor Tavella 1291, Salta, Argentina",
expected_country="ARG",
expected_first_name="Sophia",
expected_last_name="Martinez",
poa_languages_allowed="en,es",
save_api_request=True,
vendor_data="user-123",
)
print(result)import Didit, { fileFromPath } from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.proofOfAddress.verify({
document: await fileFromPath("document.pdf"),
expected_address: "Av. Monseñor Tavella 1291, Salta, Argentina",
expected_country: "ARG",
expected_first_name: "Sophia",
expected_last_name: "Martinez",
poa_languages_allowed: "en,es",
save_api_request: true,
vendor_data: "user-123",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.ProofOfAddress.Verify(ctx, didit.ProofOfAddressVerifyParams{
Document: didit.FileFromPath("document.pdf"),
ExpectedAddress: didit.String("Av. Monseñor Tavella 1291, Salta, Argentina"),
ExpectedCountry: didit.String("ARG"),
ExpectedFirstName: didit.String("Sophia"),
ExpectedLastName: didit.String("Martinez"),
POALanguagesAllowed: didit.String("en,es"),
SaveAPIRequest: didit.Bool(true),
VendorData: didit.String("user-123"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.nio.file.Path;
import me.didit.Didit;
import me.didit.types.ProofOfAddressVerifyParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.proofOfAddress().verify(ProofOfAddressVerifyParams.builder()
.document(Path.of("document.pdf"))
.expectedAddress("Av. Monseñor Tavella 1291, Salta, Argentina")
.expectedCountry("ARG")
.expectedFirstName("Sophia")
.expectedLastName("Martinez")
.poaLanguagesAllowed("en,es")
.saveApiRequest(true)
.vendorData("user-123")
.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->proofOfAddress->verify([
'document' => File::fromPath('document.pdf'),
'expected_address' => 'Av. Monseñor Tavella 1291, Salta, Argentina',
'expected_country' => 'ARG',
'expected_first_name' => 'Sophia',
'expected_last_name' => 'Martinez',
'poa_languages_allowed' => 'en,es',
'save_api_request' => true,
'vendor_data' => 'user-123',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.proof_of_address.verify(
document: Pathname("document.pdf"),
expected_address: "Av. Monseñor Tavella 1291, Salta, Argentina",
expected_country: "ARG",
expected_first_name: "Sophia",
expected_last_name: "Martinez",
poa_languages_allowed: "en,es",
save_api_request: true,
vendor_data: "user-123"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.ProofOfAddress.VerifyAsync(new ProofOfAddressVerifyParams
{
Document = FileUpload.FromPath("document.pdf"),
ExpectedAddress = "Av. Monseñor Tavella 1291, Salta, Argentina",
ExpectedCountry = "ARG",
ExpectedFirstName = "Sophia",
ExpectedLastName = "Martinez",
PoaLanguagesAllowed = "en,es",
SaveApiRequest = true,
VendorData = "user-123",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"request_id": "4b523a8d-ed32-45e4-8aa8-a89eda459d88",
"poa": {
"issuing_state": "ARG",
"document_type": "UTILITY_BILL",
"document_subtype": "WATER_BILL",
"document_language": "es",
"issuer": "Aguas del Norte",
"issue_date": "2026-04-10",
"expiration_date": null,
"poa_address": "AVDA. MONSEÑOR TAVELLA N° 1291, B° VILLA LAVALLE CP: 4400, CAPITAL - SALTA",
"poa_formatted_address": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina",
"poa_parsed_address": {
"street_1": "Avenida Monseñor Tavella 1291",
"street_2": "b",
"city": "Salta",
"region": "Salta",
"country": "AR",
"postal_code": "A4400",
"document_location": {
"latitude": -24.8208682,
"longitude": -65.4130954
}
},
"expected_details_address": null,
"expected_details_formatted_address": null,
"expected_details_parsed_address": null,
"name_on_document": "OESTE EMBOTELLADORA S.A.",
"extra_fields": {
"bank_account_number": null,
"bank_iban": null,
"bank_sort_code": null,
"bank_routing_number": null,
"bank_swift_bic": null,
"bank_branch_name": null,
"bank_branch_address": null,
"document_phone_number": null,
"additional_names": [
"LA EMBOTELLADORA DEL NORTE SA"
]
},
"detected_codes": [
{
"type": "QR_CODE",
"page_number": 1,
"position": [
[
820,
1120
],
[
1002,
1120
],
[
1002,
1302
],
[
820,
1302
]
],
"x": 820,
"y": 1120,
"width": 182,
"height": 182,
"page_width": 1190,
"page_height": 1684,
"raw_payload": "aHR0cHM6Ly9hZ3Vhc2RlbG5vcnRlLmNvbS9mYWN0dXJhLzk5ODgxMQ==",
"parsed_payload": "https://aguasdelnorte.com/factura/998811"
},
{
"type": "CODE_128",
"page_number": 1,
"position": [
[
112,
1480
],
[
560,
1480
],
[
560,
1540
],
[
112,
1540
]
],
"x": 112,
"y": 1480,
"width": 448,
"height": 60,
"page_width": 1190,
"page_height": 1684,
"raw_payload": "MDA5OTg4MTEwMDA0Mg==",
"parsed_payload": "0099881100042"
}
],
"status": "Approved",
"warnings": []
},
"vendor_data": "user-123",
"metadata": null,
"created_at": "2026-06-12T02:29:02.439655+00:00"
}API de comprovante de endereço: verificação POA e OCR
POST /v3/poa/ da Didit verifica contas de consumo, extratos e contratos de aluguel: OCR de endereço, autenticidade e pagamento por uso, sem contrato.
curl -X POST 'https://verification.didit.me/v3/poa/' \
-H 'x-api-key: YOUR_API_KEY' \
-F 'document=@./utility-bill.pdf' \
-F 'expected_address=Av. Monseñor Tavella 1291, Salta, Argentina' \
-F 'expected_country=ARG' \
-F 'expected_first_name=Sophia' \
-F 'expected_last_name=Martinez' \
-F 'poa_languages_allowed=en,es' \
-F 'vendor_data=user-123' \
--max-time 45from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.proof_of_address.verify(
document=open("document.pdf", "rb"),
expected_address="Av. Monseñor Tavella 1291, Salta, Argentina",
expected_country="ARG",
expected_first_name="Sophia",
expected_last_name="Martinez",
poa_languages_allowed="en,es",
save_api_request=True,
vendor_data="user-123",
)
print(result)import Didit, { fileFromPath } from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.proofOfAddress.verify({
document: await fileFromPath("document.pdf"),
expected_address: "Av. Monseñor Tavella 1291, Salta, Argentina",
expected_country: "ARG",
expected_first_name: "Sophia",
expected_last_name: "Martinez",
poa_languages_allowed: "en,es",
save_api_request: true,
vendor_data: "user-123",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.ProofOfAddress.Verify(ctx, didit.ProofOfAddressVerifyParams{
Document: didit.FileFromPath("document.pdf"),
ExpectedAddress: didit.String("Av. Monseñor Tavella 1291, Salta, Argentina"),
ExpectedCountry: didit.String("ARG"),
ExpectedFirstName: didit.String("Sophia"),
ExpectedLastName: didit.String("Martinez"),
POALanguagesAllowed: didit.String("en,es"),
SaveAPIRequest: didit.Bool(true),
VendorData: didit.String("user-123"),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.nio.file.Path;
import me.didit.Didit;
import me.didit.types.ProofOfAddressVerifyParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.proofOfAddress().verify(ProofOfAddressVerifyParams.builder()
.document(Path.of("document.pdf"))
.expectedAddress("Av. Monseñor Tavella 1291, Salta, Argentina")
.expectedCountry("ARG")
.expectedFirstName("Sophia")
.expectedLastName("Martinez")
.poaLanguagesAllowed("en,es")
.saveApiRequest(true)
.vendorData("user-123")
.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->proofOfAddress->verify([
'document' => File::fromPath('document.pdf'),
'expected_address' => 'Av. Monseñor Tavella 1291, Salta, Argentina',
'expected_country' => 'ARG',
'expected_first_name' => 'Sophia',
'expected_last_name' => 'Martinez',
'poa_languages_allowed' => 'en,es',
'save_api_request' => true,
'vendor_data' => 'user-123',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.proof_of_address.verify(
document: Pathname("document.pdf"),
expected_address: "Av. Monseñor Tavella 1291, Salta, Argentina",
expected_country: "ARG",
expected_first_name: "Sophia",
expected_last_name: "Martinez",
poa_languages_allowed: "en,es",
save_api_request: true,
vendor_data: "user-123"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.ProofOfAddress.VerifyAsync(new ProofOfAddressVerifyParams
{
Document = FileUpload.FromPath("document.pdf"),
ExpectedAddress = "Av. Monseñor Tavella 1291, Salta, Argentina",
ExpectedCountry = "ARG",
ExpectedFirstName = "Sophia",
ExpectedLastName = "Martinez",
PoaLanguagesAllowed = "en,es",
SaveApiRequest = true,
VendorData = "user-123",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"request_id": "4b523a8d-ed32-45e4-8aa8-a89eda459d88",
"poa": {
"issuing_state": "ARG",
"document_type": "UTILITY_BILL",
"document_subtype": "WATER_BILL",
"document_language": "es",
"issuer": "Aguas del Norte",
"issue_date": "2026-04-10",
"expiration_date": null,
"poa_address": "AVDA. MONSEÑOR TAVELLA N° 1291, B° VILLA LAVALLE CP: 4400, CAPITAL - SALTA",
"poa_formatted_address": "Av. Monseñor Tavella 1291 b, A4400 Salta, Argentina",
"poa_parsed_address": {
"street_1": "Avenida Monseñor Tavella 1291",
"street_2": "b",
"city": "Salta",
"region": "Salta",
"country": "AR",
"postal_code": "A4400",
"document_location": {
"latitude": -24.8208682,
"longitude": -65.4130954
}
},
"expected_details_address": null,
"expected_details_formatted_address": null,
"expected_details_parsed_address": null,
"name_on_document": "OESTE EMBOTELLADORA S.A.",
"extra_fields": {
"bank_account_number": null,
"bank_iban": null,
"bank_sort_code": null,
"bank_routing_number": null,
"bank_swift_bic": null,
"bank_branch_name": null,
"bank_branch_address": null,
"document_phone_number": null,
"additional_names": [
"LA EMBOTELLADORA DEL NORTE SA"
]
},
"detected_codes": [
{
"type": "QR_CODE",
"page_number": 1,
"position": [
[
820,
1120
],
[
1002,
1120
],
[
1002,
1302
],
[
820,
1302
]
],
"x": 820,
"y": 1120,
"width": 182,
"height": 182,
"page_width": 1190,
"page_height": 1684,
"raw_payload": "aHR0cHM6Ly9hZ3Vhc2RlbG5vcnRlLmNvbS9mYWN0dXJhLzk5ODgxMQ==",
"parsed_payload": "https://aguasdelnorte.com/factura/998811"
},
{
"type": "CODE_128",
"page_number": 1,
"position": [
[
112,
1480
],
[
560,
1480
],
[
560,
1540
],
[
112,
1540
]
],
"x": 112,
"y": 1480,
"width": 448,
"height": 60,
"page_width": 1190,
"page_height": 1684,
"raw_payload": "MDA5OTg4MTEwMDA0Mg==",
"parsed_payload": "0099881100042"
}
],
"status": "Approved",
"warnings": []
},
"vendor_data": "user-123",
"metadata": null,
"created_at": "2026-06-12T02:29:02.439655+00:00"
}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
O documento de Comprovante de endereço. Extensões permitidas: tiff, jpg, jpeg, png, pdf, webp. Tamanho máximo de upload: 15 MB (arquivos maiores são rejeitados com 400). PDFs com várias páginas são aceitos (espere uma latência maior); PDFs criptografados exigem document_password. As imagens são compactadas automaticamente antes do processamento.
Senha para descriptografar document quando for um PDF criptografado. Enviar um PDF criptografado sem senha (ou com uma senha errada) retorna 400.
Endereço a ser verificado em relação ao documento. Ele é geocodificado e comparado com o endereço extraído; uma divergência (ou um endereço esperado que não pode ser geocodificado/verificado) adiciona ADDRESS_MISMATCH_WITH_PROVIDED, regido por poa_address_mismatch_action. A forma geocodificada é retornada em expected_details_formatted_address / expected_details_parsed_address.
"Av. Monseñor Tavella 1291, Salta, Argentina"
País a ser verificado em relação ao documento (código ISO 3166-1, por exemplo, ARG ou AR). Uma divergência com o país do documento adiciona POA_COUNTRY_MISMATCH_WITH_PROVIDED, controlado por poa_address_mismatch_action.
"ARG"
Primeiro nome a ser verificado em relação a name_on_document (correspondência aproximada, considerando transliteração). Uma pontuação abaixo do limiar de correspondência adiciona NAME_MISMATCH_WITH_PROVIDED, controlado por poa_address_mismatch_action.
"Sophia"
Sobrenome a ser verificado em relação a name_on_document, combinado com expected_first_name para a pontuação de correspondência.
"Martinez"
Lista separada por vírgula dos idiomas de documento aceitos, como códigos ISO 639-1 (por exemplo, en,es,fr). Quando omitida ou vazia, todos os 51 idiomas compatíveis são aceitos. Um documento em um idioma fora da lista adiciona UNSUPPORTED_DOCUMENT_LANGUAGE (controlado por poa_unsupported_language_action); um código desconhecido na lista retorna 400 com o conjunto completo de códigos compatíveis.
"en,es"
Pares key:value separados por vírgula que definem a idade máxima do documento, em meses, por tipo de documento. Chaves: utility_bill, bank_statement, government_issued_document, other_poa_document; valores: 1–120, ou -1 para ilimitado (sem verificação de idade). Padrões quando omitido: utility_bill:3,bank_statement:3,government_issued_document:12,other_poa_document:12. Um documento mais antigo que o limite é recusado com POA_DOCUMENT_EXPIRED. Atenção: ao informar este campo, liste todos os tipos que você aceita; os tipos omitidos são tratados como não aceitos (informativo POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION) e a verificação de idade deles é ignorada.
"utility_bill:3,bank_statement:6"
Aceito, mas atualmente não aplicado — os avisos de divergência de nome (NAME_MISMATCH_WITH_PROVIDED) seguem poa_address_mismatch_action. Defina poa_address_mismatch_action para controlar o comportamento de divergência tanto de nome quanto de endereço.
DECLINE, NO_ACTION O que fazer em problemas de integridade do arquivo — na prática, este endpoint só gera DOCUMENT_METADATA_MISMATCH.
DECLINE, NO_ACTION O que fazer quando há suspeita de manipulação do documento (SUSPECTED_DOCUMENT_MANIPULATION) — por exemplo, o PDF foi modificado após a assinatura digital, processado por um editor de PDF conhecido, apresenta manipulação por sobreposição de texto ou tem datas EXIF inconsistentes.
DECLINE, NO_ACTION O que fazer quando o idioma do documento está fora de poa_languages_allowed (UNSUPPORTED_DOCUMENT_LANGUAGE).
DECLINE, NO_ACTION O que fazer quando os dados extraídos divergem dos campos expected_*: ADDRESS_MISMATCH_WITH_PROVIDED, NAME_MISMATCH_WITH_PROVIDED e POA_COUNTRY_MISMATCH_WITH_PROVIDED seguem todos esta ação.
DECLINE, NO_ACTION O que fazer quando nenhuma empresa ou organização emissora pode ser identificada no documento (ISSUER_NOT_IDENTIFIED).
DECLINE, NO_ACTION 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 o documento enviado armazenado. Quando false, nada é armazenado e request_id é um UUID transitório usado apenas para correlacionar a resposta.
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. poa.status é Approved ou Declined; cada problema detectado é detalhado em poa.warnings. Um documento expirado, divergente ou suspeito 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.
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.