Diagnóstico de 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 imagem, a fim de detectar ataques de apresentação direcionados ao roubo de identidade.
O resultado da validação pode retornar os seguintes valores:
Credible: O documento é genuíno.
Doubtful: Não é possível garantir que o documento seja genuíno.
Spoof: O documento parece não ser genuíno.
Error: 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 malsucedidas.
Requisitos da imagem
Requisitos mínimos
Imagens HD, resolução mínima: 720px
Pixels que mostrem o fundo ao redor do documento, cobrindo pelo menos 5% da 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 ocupando mais de 5% do documento
Sem compressão, em formatos como PNG
Foto bem iluminada, sem desfoque nem reflexos de luz
Endpoint
Cabeçalhos
x-api-key
string
Sim
API Key para autorização de acesso.
family
string
Não
Valor: OnBoarding. Obrigatório com o serviço de tracking.
Corpo da solicitação
Content-Type: application/json
Parâmetros
frontSideImage
string
Sim
Imagem codificada em Base64 do lado frontal do documento a ser validado.
backSideImage
string
Sim
Imagem codificada em Base64 do lado posterior do documento a ser validado.
face
string
Não
Imagem codificada em Base64 do rosto da pessoa a ser validada (opcional).
tokenized
boolean
Sim
Define se as imagens são enviadas em formato tokenizado ou em formato simples.
countryCode
string
Sim
Código ISO Alpha-3 do país emissor do Documento de identidade.
idType
string
Sim
Tipo de documento a ser validado. Valores possíveis: PASSPORT, ID_CARD, RESIDENCE_PERMIT, DRIVERS_LICENSE, DRIVING_LICENSE, VISA
tracking
object
Não
Objeto que representa as informações de acompanhamento 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 da operação gerado pelo SDK Mobile/Web.
Exemplo de solicitação
Respostas
200 Sucesso
Parâmetros da resposta
serviceTransactionId
string
Identificador da transação associada à 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
Registro de data e hora (UTC) da resposta no formato ISO 8601.
serviceResult
object
Objeto com o resultado da validação. Consulte a tabela abaixo.
serviceDocumentData
string
String JSON com os dados extraídos por OCR do Documento de identidade.
serviceTime
string
Tempo de processamento (milissegundos).
Parâmetros da resposta — serviceResult.result
decision
string
Não
Decisão da validação. Valores possíveis: Credible, Doubtful, Spoof, Error. Consulte Resultados da validação de diagnóstico PAD.
reason
string
Sim
Motivo da rejeição (presente quando a decisão não é Credible). Consulte Motivos de rejeição do diagnóstico PAD.
IQA
object
Sim
Dados de avaliação da qualidade da imagem (Image Quality Assessment).
Parâmetros da resposta — serviceResult (adicionais)
api_version
string
Versão da API usada no processamento.
processing_modules_time
string
Tempo de execução dos módulos de processamento.
Código do resultado do serviço
O serviceResultCode indica o resultado geral da execução do serviço:
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:
Credible
O documento é genuíno.
Doubtful
Não é possível determinar se o documento é genuíno.
Spoof
O documento parece não ser genuíno.
Error
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:
Screen_Replay_Attack
Um invasor apresenta uma imagem ou um 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 em preto e branco.
Photo_Replacement_Attack
A região dos dados parece genuína, mas há uma fotografia impressa sobre a região do retrato. Não detecta manipulações digitais.
SECURITY_PHOTO_CHECK
A foto do retrato no Documento de identidade foi manipulada.
SECURITY_DATA_CHECK
Os dados do documento apresentam alterações no conteúdo.
SECURITY_OCR_CHECK
A comparação dos dados comuns entre a frente 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 Proibido
502 Gateway inválido
504 Tempo limite do gateway
Atualizado