Validação de Documentos via imagem (BETA)

A API IDwall oferece um serviço que extrai os dados da fotografia para validação do documento. Inicialmente, este recurso só está disponível para CNH.

Este é um recurso assíncrono. Você deve ter configurado uma URL de webhook para receber uma chamada quando o processamento da imagem tiver sido concluído.


Aviso

Enquanto estiver em BETA, o recurso ainda está sujeito a alterações e instabilidade. A URL base, https://validacao.idwall.co/ será alterada a partir da próxima versão.


Requisitos técnicos de imagens

As imagens de documentos enviadas para validação devem cumprir os requisitos descritos no link: https://goo.gl/UD4ge0

CNH

nome string Nome em letras MAIÚSCULAS e sem acentos
rg string RG sem dígitos
orgao_emissor_rg string  
estado_emissao_rg string Estado no formato XX
cpf string CPF sem pontuação
data_de_nascimento string Data no formato dd/mm/aaaa
nome_do_pai string Nome em letras MAIÚSCULAS e sem acentos
nome_da_mae string Nome em letras MAIÚSCULAS e sem acentos
permissao string  
acc string  
categoria string Categoria em letras MAIÚSCULAS
numero_registro string  
validade string Data no formato dd/mm/aaaa
data_primeira_habilitacao string Data no formato dd/mm/aaaa
numero_espelho string  
observacoes string  
local_emissao string  
data_de_emissao string Data no formato dd/mm/aaaa
numero_renach string  
numero_seguranca string  
orgao_emissor string  
estado_emissao string Estado no formato XX

Enviando um novo documento

Esta solicitação é usada para enviar uma imagem para processamento.

Parâmetros

frente Arquivo de imagem no formato .jpeg, .jpg ou .png via multipart/form-data
verso Arquivo de imagem no formato .jpeg, .jpg ou .png via multipart/form-data
tipo cnh | rg | passaporte
matriz Nome da matriz de decisão que será executada após a extração dos dados (Protocolo será gerado com o mesmo número)

Retorna uma title de status.

Considerações

  • Serão aceitos os formatos .jpeg, .jpg ou .png
  • Todos os campos do documento deve estar claramente visíveis na imagem
  • É recomendado que o tamanho do arquivo não ultrapasse 2MB

Definição

Exemplo requisição

Exemplo retorno

{
  "numero": "760c0cb2-1a2b-4a22-8b13",
  "tipo": "cnh",
  "uri": "/documentos/760c0cb2-1a2b-4a22-8b13",
  "status": "pendente"
}

Consulta status de processamento de imagem

Esta solicitação é usada para consultar o status de processamento de uma imagem.

Definição

Exemplo requisição

Exemplo retorno

{
  "numero": "760c0cb2-1a2b-4a22-8b13",
  "tipo": "cnh",
  "uri": "/documentos/760c0cb2-1a2b-4a22-8b13",
  "status": "processando",
}

Webhooks

Você pode configurar uma URL de webhook para receber as notificações de processamento das imagens.

Veja abaixo a lista de eventos que ativam o webhook.

Evento Descrição
documento_processando Documento começou a ser processado
documento_concluido Documento terminou de ser processado
documento_em_analise Documento entrou em análise manual
documento_erro Erro no processo

A IDwall ainda não tem implementada a retentativa de entrega, portanto a requisição é enviada apenas uma vez, mesmo se o seu sistema apresentar um erro ao recebê-la.

Exemplo retorno de status

{
  "event" : "documento_concluido",
  "title" : "Documento terminou de ser processado",
  "data" : {
    "numero" : "760c0cb2-1a2b-4a22-8b13",
    "tipo": "cnh",
    "uri": "/documentos/760c0cb2-1a2b-4a22-8b13",
    "status": "concluido",
    "data" : {
      "nome" : "Jonathas Henrique de Oliveira",
      "rg" : "44.389.480-1",
      "orgao_emissor_rg" : "SSP",
      "estado_emissao_rg" : "SP",
      "cpf" : "72182911280",
      "data_de_nascimento" : "15/08/1988",
      "nome_do_pai" : "Maria de Oliveira",
      "nome_da_mae" : "Pedro Augusto de Oliveira Filho",
      "permissao" : "",
      "acc" : "",
      "categoria" : "A",
      "numero_registro" : "237912793123",
      "validade" : "14/03/2019",
      "data_primeira_habilitacao" : "14/03/1999",
      "numero_espelho" : "837261000",
      "observacoes" : "Exerce atividade remunerada",
      "local_emissao" : "Campinas",
      "data_de_emissao" : "14/03/1999",
      "numero_renach" : "MA9012392831",
      "orgao_emissor" : "DETRAN",
      "estado_emissao" : "SP"
    }
  }
}

Exemplo retorno de erro

{
  "event" : "documento_erro",
  "title" : "Imagem ilegível",
  "data" : {
    "numero" : "760c0cb2-1a2b-4a22-8b13",
    "tipo": "cnh",
    "uri": "/documentos/760c0cb2-1a2b-4a22-8b13",
    "status": "concluido",
    "data" : {
      "nome" : null,
      "rg" : null,
      "orgao_emissor_rg" : null,
      "estado_emissao_rg" : null,
      "cpf" : null,
      "data_de_nascimento" : null,
      "nome_do_pai" : null,
      "nome_da_mae" : null,
      "permissao" : null,
      "acc" : null,
      "categoria" : null,
      "numero_registro" : null,
      "validade" : null,
      "data_primeira_habilitacao" : null,
      "numero_espelho" : null,
      "observacoes" : null,
      "local_emissao" : null,
      "data_de_emissao" : null,
      "numero_renach" : null,
      "orgao_emissor" : null,
      "estado_emissao" : null
    }
  }
}

Retornos de Erro

Padrão retorno

{
  "title" : "Documento não encontrado",
}

Mensagens de erro

Code Título Detalhes
400 Documento não encontrado O documento enviado como parâmetro não foi encontrado
400 Imagem ilegível A imagem possui alguma interferência que impossibilita a leitura
400 Imagem inválida Tipo de arquivo inválido (somente são aceitos .jpg, .jpeg e .png)
400 Imagem não enviada A requisição foi enviada sem o arquivo
500 Erro Erro ao processar requisição