Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Diagnóstico PAD de documento

Serviço que permite verificar se o suporte de um documento de identidade é genuíno ou não por meio da análise da sua imagem, com o objetivo de detectar ataques de apresentação direcionados ao roubo de identidade.

O resultado da validação pode retornar os seguintes valores:

  • Crível: O documento é genuíno.

  • Duvidoso: Não é possível assegurar se o documento é genuíno.

  • Spoof: O documento parece não ser genuíno.

  • Erro: O processo de validação encontrou um erro.

O resultado é fornecido no campo decision da resposta do serviço, junto com o campo reason que especifica a causa das validações insatisfatórias.

Requisitos de imagem

Requisitos mínimos

  • Imagens HD, resolução mínima: 720px

  • Pixels que mostrem o fundo ao redor do documento de pelo menos 5% da sua largura

  • Nível mínimo de compressão: JPEG 70

  • O texto do documento deve ser legível por um OCR

Requisitos recomendados

  • Imagens FullHD, resolução mínima: 1080px

  • Documento centralizado na imagem e que ocupe mais de 5% do documento

  • Sem compressão, com formatos como PNG

  • Foto bem iluminada, sem desfoque nem reflexos de luz

Endpoint

Cabeçalhos

Nome
Tipo
Obrigatório
Descrição

x-api-key

string

Sim

API Key de autorização de acesso.

family

string

Não

Valor: Onboarding. Obrigatório com o serviço de tracking.

Todas as chamadas aos Endpoints para tracking com Identity Platform devem conter o header family.

Corpo da solicitação

Content-Type: application/json

Parâmetros

Parâmetro
Tipo
Obrigatório
Descrição

frontSideImage

string

Sim

Imagem codificada em Base64 do lado frontal do documento a validar.

backSideImage

string

Sim

Imagem codificada em Base64 do lado posterior do documento a validar.

face

string

Não

Imagem codificada em Base64 do rosto da pessoa a validar (opcional).

tokenized

boolean

Sim

Define se as imagens são enviadas em formato tokenizado ou em formato plano.

countryCode

string

Sim

Código ISO Alpha-3 do país emissor do documento de identidade.

idType

string

Sim

Tipo de documento a validar. Valores possíveis: PASSPORT, ID_CARD, RESIDENCE_PERMIT, DRIVERS_LICENSE, DRIVING_LICENSE, VISA

tracking

object

Não

Objeto que representa as informações de tracking necessárias.

tracking.extraData

string

Não

Token gerado pelo SDK Mobile/Web. Contém informações de tracking tokenizadas com a Plataforma.

tracking.operationId

string

Não

Identificador de operação gerado pelo SDK Mobile/Web.

Exemplo de solicitação

Respostas

200 Sucesso

Parâmetros de resposta

Parâmetro
Tipo
Descrição

serviceTransactionId

string

Identificador de transação associado à solicitação processada pela API.

serviceResultCode

integer

Código que indica o resultado geral da execução do serviço.

serviceResultLog

string

Campo descritivo do resultado da execução.

timestamp

string

Marca de tempo (UTC) da resposta no formato ISO 8601.

serviceResult

object

Objeto com o resultado da validação. Veja a tabela a seguir.

serviceDocumentData

string

String JSON com os dados extraídos por OCR do documento de identidade.

serviceTime

string

Tempo de processamento (milissegundos).

Parâmetros de resposta — serviceResult.result

Parâmetro
Tipo
Nullable
Descrição

decision

string

Não

Decisão da validação. Valores possíveis: Crível, Duvidoso, Spoof, Erro. Ver Resultados da validação de diagnóstico PAD.

reason

string

Sim

Motivo da rejeição (presente quando a decisão não é Crível). Veja Motivos de rejeição do diagnóstico PAD.

IQA

object

Sim

Dados de avaliação da qualidade da imagem (Image Quality Assessment).

Parâmetros de resposta — serviceResult (adicionais)

Parâmetro
Tipo
Descrição

api_version

string

Versão da API utilizada para o processamento.

processing_modules_time

string

Tempo de execução dos módulos de processamento.

Service Result Code

O serviceResultCode indica o resultado geral da execução do serviço:

serviceResultCode
Descrição
Código HTTP

0

A execução do serviço foi bem-sucedida, o módulo processou a solicitação corretamente.

200

Resultados da validação de diagnóstico PAD

O serviço de diagnóstico PAD (Presentation Attack Detection) retorna os resultados da validação no campo decision:

decision
Descrição

Crível

O documento é genuíno.

Duvidoso

Não é possível assegurar se o documento é genuíno.

Spoof

O documento parece não ser genuíno.

Erro

O processo de validação encontrou um erro.

Motivos de rejeição do diagnóstico PAD

Quando o resultado da validação não é satisfatório, o campo reason fornece detalhes específicos:

reason
Descrição

Screen_Replay_Attack

Um atacante apresenta uma imagem ou vídeo de um documento diante da câmera.

Black_and_White_Printed_Copy_Attack

Detecção de documentos impressos em papel em escala de cinza ou preto e branco.

Photo_Replacement_Attack

A região de dados parece genuína, mas a região do retrato tem uma fotografia impressa por cima. Não detecta manipulações digitais.

SECURITY_PHOTO_CHECK

A foto do retrato no documento de identidade está manipulada.

SECURITY_DATA_CHECK

Os dados do documento mostram alterações em seu conteúdo.

SECURITY_OCR_CHECK

A comparação de dados comuns entre o anverso e o verso do documento de identidade falha.

NOT_PROCESSED_OCR

Não foi possível extrair os dados OCR do documento de identidade.

NOT_PROCESSED_PHOTO_CHECK

Não foi possível realizar a verificação da foto do retrato do documento de identidade.

NOT_PROCESSED_DATA_CHECK

Não foi possível realizar a verificação dos valores dos campos do documento de identidade.

Exemplo de resposta — Validação bem-sucedida

Exemplo de resposta — Erro

400 Solicitação inválida

401 Não autorizado

403 Acesso negado

502 Gateway inválido

504 Gateway Timeout

AnteriorDados da validação de documento V2PróximoOCR

Atualizado