Obtendo status de um relatório

Como obter o status de um relatório ?

Para obter o status de um relatório específico, basta realizar uma simples requisição com o método GET para a nossa API no seguinte endpoint: https://api-v2.idwall.co/relatorios passando como parâmetro do próprio caminho o número do relatório como mostra o exemplo abaixo.

curl -X GET https://api-v2.idwall.co/relatorios/numero_relatorio
 -H "Content-Type: application/json"
 -H 'Authorization:seu-token'

Exemplo de sucesso

{
    "result": {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "CONCLUIDO",
        "nome": "consultaPessoaDefault",
        "mensagem": "Válido.",
        "resultado": "VALID",
        "validado_em": "2018-11-19T19:34:46.815Z",
        "validado_por": null,
        "validado_manualmente": false,
        "atualizado_em": "2018-11-19T19:39:43.565Z",
        "criado_em": "2018-11-19T19:34:46.515Z",
        "criado_por": "Severo Snape"
    },
    "status_code": 200
}
  • atualizado_em: Este parâmetro informa a última vez que uma fonte que foi utilizada para consulta retornou um dado.

  • resultado: Este parâmetro informa o resultado final do relatório, ou seja, se ele precisa ou não de uma revisão manual.

OBS: Caso o parâmetro resultado venha preenchido como INVALID ele precisará de uma validação manual, para entender melhor como a validação manual funciona, basta clicar aqui.

Exemplo de erro

{
  "error": "Unauthorized",
  "message": "Falha na autenticação. Por favor verifique o token utilizado e se o acesso foi liberado.",
  "status_code": 401
}
{
  "error": "Not Found",
  "message": "Protocolo não encontrado.",
  "status_code": 404
}

What’s Next