Listar todos os relatórios

Como listar os relatórios anteriormente criados ?

Agora que sabemos como criar os nossos relatórios, vamos aprender como listá-los via API.

O endpoint responsável pela listagem de relatórios é: https://api-v2.idwall.co/relatorios, agora basta realizar uma requisição com o método GET e você irá receber uma resposta com os relatórios que foram criados na sua conta. Segue um exemplo de requisição.

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

Exemplo de sucesso

{
  "result": {
    "itens": [
      {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "PROCESSANDO",
        "tipo_pessoa": "Pessoa",
        "nome": "Nome matriz",
        "atualizado_em": "2018-11-03T17:45:44.476Z",
        "resultado": null,
        "mensagem": "Validação Pendente.",
        "pendente_validacao_manual": false,
        "numero_documento": "xxxxxxxxxxx"
      },
      {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "EM ANALISE",
        "tipo_pessoa": "Pessoa",
        "nome": "Nome matriz",
        "atualizado_em": "2018-11-03T17:32:16.857Z",
        "resultado": null,
        "mensagem": "Validação Pendente.",
        "pendente_validacao_manual": true,
        "numero_documento": "xxxxxxxxxxx"
      },
      {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "CONCLUIDO",
        "tipo_pessoa": "Empresa",
        "nome": "Nome matriz",
        "atualizado_em": "2018-11-03T16:43:00.572Z",
        "resultado": "VALID",
        "mensagem": "Válido.",
        "pendente_validacao_manual": true,
        "numero_documento": "xxxxxxxxxxxxxx"
      },
      {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "CONCLUIDO",
        "tipo_pessoa": "Pessoa",
        "nome": "Nome matriz",
        "atualizado_em": "2018-11-03T14:53:57.413Z",
        "resultado": "VALID",
        "mensagem": "Válido.",
        "pendente_validacao_manual": false,
        "numero_documento": "xxxxxxxxxxx"
      }
    ],
    "paginacao": {
      "atual": 1,
      "linhas": 25,
      "total": 5
    }
  },
  "status_code": 200
}

Os relatórios sempre virão ordenados do mais atual ao menos atual

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
}

Filtros

Você também pode realizar buscas com filtros por meio dos parâmetros passados pela urlencoded, abaixo segue exemplos de filtros que podem ser utilizados em nossa API.

Paginação e linhas

curl -G https://api-v2.idwall.co/relatorios
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "page=1&rows=25"

o número de linhas precisa ser sempre um múltiplo de 25

Filtros para buscas

Nome do parâmetro

Parâmetro aceito

numero_documento

Pode-se utilizar tanto o número do CPF quanto o número do CNPJ

tipo_pessoa

Utilizar PESSOA quando quiser filtrar pessoas físicas e utilizar EMPRESA para filtrar pessoas jurídicas

nome

Utilizar o nome da matriz que deseja utilizar como filtro

numero

Utilizar o número de identificação do relatório

resultado

Utilizar VALID quando quiser filtrar relatórios que foram validados e utilizar INVALID para filtrar os relatórios que foram invalidados

status

Utilizar este parâmetro para filtrar os relatórios pelos diferente tipos de status que ele pode assumir.

pendente_validacao_manual

Utilizar "true" quando quiser filtrar relatórios que necessitam de validação manual e utilizar "false" quando quiser filtrar relatórios que não necessitam de validação manual.

curl -G https://api-v2.idwall.co/relatorios
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "numero_documento=numero_CPF_ou_CNPJ"
curl -G https://api-v2.idwall.co/relatorios
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "tipo_pessoa=Pessoa_ou_Empresa"
curl -G https://api-v2.idwall.co/relatorios
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "nome=nome_matriz"
curl -G https://api-v2.idwall.co/relatorios
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "numero=numero_relatorio"
curl -G https://api-v2.idwall.co/relatorios
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "resultado=VALID_ou_INVALID"
curl -G https://api-v2.idwall.co/relatorios
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "status=CONCLUIDO"

Ordenação de resultados

É possível ordenar os resultados da sua requisição de forma crescente ou decrescente com base em um parâmetro presente na mesma, para isso basta informar o nome do campo que deseja utilizar como parâmetro de ordenação como mostra os exemplos abaixo.

curl -G https://api-v2.idwall.co/relatorios
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "sort=nome_do_parametro"
curl -G https://api-v2.idwall.co/relatorios
-H "Content-Type: application/x-www-form-urlencoded"
-H 'Authorization:seu-token'
-d "sort=-nome_do_parametro"

What’s Next