Bem vindo a documentação da IDwall

Aqui você vai encontrar tudo que precisa para integrar o seu sistema com a nossa API

Vamos lá!

Entendendo um relatório

O que é um relatório ?

Pode-se definir um relatório como um conjunto de informações advindas de um processamento de dados provenientes de fontes públicas e/ou privadas que se baseiam nos dados que foram entregues pelo cliente que realizou a requisição do relatório.

Você pode criar diferentes tipos de relatórios com diferentes combinações de fontes e validações, após a criação deles é possível visualizá-los na página inicial do seu dashboard .

Ciclo de vida de um relatório

Um relatório pode possuir 4 status desde a sua concepção até o momento da finalização, abaixo segue uma tabela com os diferentes status e o significado de cada um deles.

Status
Significado

PRE-PROCESSANDO

É o momento em que a imagem enviada está passando pelo nosso OCR para que os dados sejam extraídos para serem utilizados na consulta.

PROCESSANDO

Aguardando as fontes da consulta terminarem a pesquisa para enviar a resposta.

EM ANÁLISE

Este status aparece quando uma das nossas fontes de consulta de dados está apresentando instabilidade.

CONCLUÍDO

Todas as fontes foram consultadas e todos os critérios de validação foram realizados com base nas informações colhidas da matriz utilizada

Caso tenha ficado alguma dúvida acesse o nosso artigo ou mande um e-mail para suporte@idwall.co.

Agora que sabemos o que é um relatório e como ele se comporta, vamos entender como realizar a requisição do mesmo para o nosso sistema.

Criando um relatório

Para criar um relatório em nosso sistema basta realizar uma requisição com o método POST para o seguinte endpoint: https://api-v2.idwall.co/relatorios passando os parâmetros pedidos diretamente no corpo da requisição.

Vide o exemplo abaixo.

curl -X POST https://api-v2.idwall.co/relatorios
-H "Content-Type: application/json"
-H 'Authorization:seu-token'
-d ' {
      	"matriz": "consultaPessoaDefault",
        "parametros": {
          "cpf_data_de_nascimento": "20/08/1881",
          "cpf_nome": "Alvo Percival Wulfric Brian Dumbledore",
          "cpf_numero": "71393401881"
      	}
      }'

O corpo da requisição e os parâmetros variam de matriz para matriz ?

Sim, por essa razão é sempre aconselhado se você possuir mais de uma matriz em sua conta visitar a sua dashboard na parte da integração com a API para adquirir o corpo da requisição correto para realizar a consulta como exemplificado na sessão denominada dashboard .

Exemplo de sucesso

Se a requisição for executada e processada com sucesso, será enviada uma resposta para o seu sistema no formato que segue abaixo.

{
  "status_code": 200,
  "result": {
    "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  }
}

Exemplo de erro

{
    "error": "Bad Request",
    "message": "child \"parametros\" fails because [\"dado_aleatorio\" is not allowed]",
    "validation": {
        "source": "payload",
        "keys": [
            "parametros.dado_aleatorio"
        ]
    },
    "status_code": 400
}
{
  "error": "Unauthorized",
  "message": "Falha na autenticação. Por favor verifique o token utilizado e se o acesso foi liberado.",
  "status_code": 401
}

Erro 400

Este erro ocorre quando é enviado um parâmetro que não esta listado na sua matriz

Enviando uma imagem como parâmetro

Existe duas maneiras de enviar uma imagem como parâmetro para o nosso sistema, a primeira é passar a URL do servidor onde a mesma está hospeda, a segunda é passar a imagem em base 64.

vide exemplos abaixo.

{
  "matriz": "nome_da_matriz",
  "parametros": {
    "cnh_imagem_completa": "https://example.com/my_full_image.jpg",
    "imagens_face_match":["https://example.com/image_1.jpg",""]
  }
}
{
  "matriz": "nome_da_matriz",
  "parametros": {
    "cnh_imagem_completa": "data:image/png;base64, aW1hZ2VfZXhhbXBsZQ==",
    "imagens_face_match": ["data:image/png;base64, aW1hZ2VfZXhhbXBsZTI=",""]
  }
}

Só é aceito um formato de imagem ?

Não, nossa API suporta as extensões de imagens mais utilizadas, basta mudar o formato da mesma antes da criação do relatório.

Exemplo: https://example.com/image_1.png, https://example.com/image_1.jpeg


Entendendo um relatório


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.