Serviços em nuvem da VU

Extraia os dados do documento e valide frente e verso

Um documento montado com a frente de uma pessoa e o verso de outra passa por qualquer controle que só verifica se a leitura funcionou. ID Analysis é um serviço que você pode consumir via API para ler a frente e o verso a partir de uma foto, identificar o tipo de documento e validar que o verso corresponde ao documento da frente.

Para gerar sua API Key, você precisa de um plano pago da VU.

Documento de identidadeFrente
Foto do titular na frente do documento
Mesmo documentoVerso
"code": 200 · "message": "Operation end successfully.""frontBackTemplateValidation": trueCorresponde à frente · você segue com os dados

Segurança respaldada por certificações e testes independentes

Conforme ao iBeta PAD Nível 3

ISO/IEC 30107-3 · Prova de vida

ISO/IEC 27001:2022

Gestão de segurança da informação

ISO/IEC 27017:2015

Segurança em serviços de nuvem

O problema

Ler os dois lados não garante que sejam do mesmo documento

Se alguém combina a frente de um documento com o verso de outro, o OCR extrai dados de cada lado e a resposta chega sem erros. O mesmo ocorre com uma foto em que não há nenhum documento legível: a API responde com código 200, com uma mensagem diferente e sem dados. Um fluxo que só verifica o código de status aceitará os dois casos.

  • A API respondeu✓ 200
  • A mensagem é de sucesso✓ "Operation end successfully."
  • Os dados do verso foram lidos✓ lidos
  • O verso corresponde à frente?false
Nossa solução

Os dados do documento, com frente e verso validados.

Da frente, o ID Analysis extrai os campos impressos, lê a zona MRZ e o código de barras (se o documento os incluir), identifica o tipo de documento e recorta o rosto. Do verso, extrai os dados disponíveis e valida que correspondem à frente. A decisão de aceitar o cliente não é automática: você recebe os dados e as validações, e sua política define o que aceitar.

Caso 01

Você já conta com outro fornecedor

Não é necessário migrar toda a sua operação para incorporar a leitura de documentos. Você pode consumir apenas esta API, em paralelo com seu fornecedor atual.

Caso 02

Você recebe documentos de diferentes países

Identifica o tipo de documento a partir de um catálogo de mais de 90 templates da região. Antes de integrá-la, você pode consultar quais campos cada um inclui.

Caso 03

Você está desenvolvendo seu próprio onboarding

Você precisa ler o documento e recortar o rosto para compará-lo com a selfie. Combina esta API com o Face Analysis e mantém o controle sobre o resto do processo.

Características principais

Três fontes de dados, cruzadas entre si

Lê a zona visual, a MRZ e o código de barras quando o documento os tem, e diz quanto coincidem entre si, campo por campo.

Lê de
  • Zona visual (VIZ)Os campos impressos do documento
  • Código de barrasQuando o documento tem
  • MRZA zona de leitura mecânica, com seus dígitos verificadores
Devolve
  • POST /frontTipo de documento"id": "VU-ARG-ID-04"Contra mais de 90 templates da região
  • POST /frontRecorte do rostoPronto para comparar com o Face Analysis
  • POST /backValidação de frente e verso"frontBackTemplateValidation": trueO verso é do mesmo documento?
  1. Zona visual (VIZ)Os campos impressos do documento
  2. POST /frontTipo de documento"id": "VU-ARG-ID-04"Contra mais de 90 templates da região
  3. POST /frontRecorte do rostoPronto para comparar com o Face Analysis
  4. Código de barrasQuando o documento tem
  5. MRZA zona de leitura mecânica, com seus dígitos verificadores
  6. POST /backValidação de frente e verso"frontBackTemplateValidation": trueO verso é do mesmo documento?

Os dados que traz, e quanto confiar em cada um

Consistência entre fontes

Compara entre si a MRZ, o código de barras e a zona visual, com uma porcentagem de coincidência de 0 a 100 para cada campo. O serviço não impõe um limiar: você decide em cada campo, conforme os dados que alimentam seu processo.

Catálogo de templates

Você consulta quais campos, MRZ e código de barras cada documento inclui, e faz testes com imagens de amostra anonimizadas antes de usar documentos reais.

Integração

Não substitui o Identity Link quando você precisa de uma verificação completa. Você pode usá-lo de forma independente ou combiná-lo com outros serviços em nuvem da VU.

Antispoofing do documento (opcional)

Analisa se a imagem corresponde a um documento real ou a uma reprodução, e se a foto do titular foi adulterada. O resultado é informativo: a resposta chega com código 200 e seu sistema decide o que fazer.

A integração

Duas chamadas e uma regra de decisão.

Chamadas HTTP a partir do seu backend: a chave nunca fica exposta em um app móvel nem no navegador.

ElementoComo funciona
POST /frontAnalisa a frente e devolve o uuid que a vincula ao verso
POST /backAnalisa o verso e o cruza com a frente, usando esse uuid como relatedUuid
GET /listTemplatesOs documentos suportados. Com /{templateId}/details, quais campos esperar de cada um, e com /{templateId}/images, imagens de amostra anonimizadas
GET /versionVerifica a conectividade. Avalia-se o código de status, não o corpo
AutenticaçãoCabeçalho Api-Key. Cada serviço tem sua própria chave, por ambiente
URL baseA VU entrega junto com a chave, conforme o ambiente
Entradainfo como referência de negócio e image em base64. No verso, também relatedUuid
Saídauuid, id (o tipo de documento), front e back com os dados, crossMatchConfidence, code e message
RequisiçãoPOST /back
// Cabeçalho: Api-Key: <sua chave do serviço>
{
  "info": "onboarding-12345",
  "image": "<foto do verso em base64, sem prefixo>",
  "relatedUuid": "<o uuid que POST /front devolveu>"
}
  • "frontBackTemplateValidation": trueO verso corresponde à frente. Você revisa a consistência dos dados e decide.
  • "frontBackTemplateValidation": falseÉ o verso de outro documento. Você não aceita.
  • "message": "Cant get document fields"Na frente: não foi possível ler o documento. Você pede outra captura.
A regra de decisãoSeu backend
// Frente: aceitar exige as três condições.
const frenteOk =
    status === 200 &&
    body.message === "Operation end successfully." &&
    body.id !== "unknown";

// Verso: além do anterior.
const versoOk = body.back.frontBackTemplateValidation === true;
// E você revisa body.crossMatchConfidence antes de dar os dados por bons.

Um 200 não significa dados extraídos

Uma foto sem documento legível também responde 200, com a mensagem "Cant get document fields" e o tipo de documento como "unknown". E um verso que não corresponde à frente responde 200 com "Operation end successfully.". Se você decidir só pelo código de status, aceita documentos ilegíveis e documentos montados com lados de dois documentos diferentes.

Requisitos da imagem

A foto decide quantos campos podem ser lidos.

AspectoValor
ResoluçãoMínimo 480 × 480. Até 1920 px de lado melhora a leitura*
EnquadramentoO documento inteiro, apoiado e sem reflexos
FormatoJPEG ou PNG. Se for JPEG, qualidade 90 ou superior
Codificaçãobase64 sem prefixo data: e sem quebras de linha

*Abaixo de 480 × 480 a API devolve erro. Acima de 1920 px a imagem é reduzida automaticamente, então enviar mais não melhora a leitura.

Os reflexos esvaziam camposOs brilhos sobre o laminado e os dedos cobrindo dados são a principal causa de campos vazios e de documentos ilegíveis. Oriente a captura antes de enviá-la: documento inteiro, apoiado e sem reflexos.
Como começar

Autogerenciável, conecte esta API sem intermediários

Com um plano pago, você gera a chave no painel da VU e chama o serviço a partir do seu backend.

  1. 02

    Você confirma o acessocom o método que o painel oferecer

  2. 03

    Você abre Cloud Servicesno menu lateral

  3. 04

    Você escolhe ID Analysisentre os serviços disponíveis

  4. 05

    Você gera a API keycom um plano pago, para o ambiente que vai usar

  5. 06

    Você copia a chave e chama GET /versionpara confirmar a rede. A chave é testada com o primeiro /front

Gere sua API Key

Para gerar sua API Key, você precisa de um plano pago da VU.

Perguntas frequentes

Não. Você pode consumi-la de forma independente, com sua própria chave, sobre o fluxo que escolher. Convive com o fornecedor que você já tem instalado.
O ID Analysis conta com um catálogo de mais de 90 templates de documentos da região. Com GET /listTemplates você pode consultar os documentos suportados, os campos, a MRZ e o código de barras que cada um inclui, e obter imagens de amostra anonimizadas para fazer testes antes de usar documentos reais.
Você pode analisar só a frente com POST /front e obter os dados desse lado. Nesse caso, a validação entre frente e verso não se aplica.
Sim, se você solicitar. O antispoofing do documento analisa se a imagem corresponde a um documento real ou a uma reprodução, e se a foto do titular foi adulterada. O resultado é informativo: a resposta chega com código 200 e seu sistema decide o que fazer.
No cabeçalho Api-Key de cada requisição. Cada serviço tem sua própria chave para cada ambiente, e a VU a fornece junto com a URL base correspondente.
Se não houver nenhum documento legível na foto, a API responde com código 200, com uma mensagem diferente e sem dados. Por isso, seu fluxo não deve se basear só no código de status: verifique também code, message e se os dados esperados estão presentes.

Você já tem os documentos. Falta lê-los e cruzá-los.

Gere sua chave e teste com um documento que você já conhece, ou com as imagens de amostra do catálogo.

Gere sua API Key

Para gerar sua API Key, você precisa de um plano pago da VU.