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á!
Suggest Edits

Por onde começar

 

Seja bem-vindo à referência da API da IDwall. Aqui você encontrará todas as nossas rotas de integração com exemplos de sucesso e de erros que podem vir a ocorrer.

1. Autenticação

Para realizar consultas e criar relatórios via API, é necessário que você possua um token de autenticação. Ele está disponível em seu Dashboard, na parte de integração da API .

Aviso

Caso você não possua uma conta, clique aqui e preencha o formulário. Após o envio a nossa equipe irá entrar contato o mais rápido possível para guiá-lo pelo caminho de criação da sua conta até a obtenção do token de autenticação.

2. API

A nossa APl é RESTful , onde todas as suas respostas são em formato JSON . Abaixo segue o nosso endpoint base.

3. Ambiente de teste e de produção.

No cenário atual não possuímos uma sandbox para realização de testes do nosso sistema, ou seja, uma vez contratado você rodará em produção todo o tempo.

4. Códigos HTTP de retorno da nossa API

Nesta seção serão apresentados os possíveis códigos HTTP que podem ser enviados pela nossa API. Caso você tenha curiosidade sobre os diferentes códigos HTTP que existem clique aqui.

Código de resposta
Descrição

200

Sua requisição foi realizada e processada com sucesso.

401

Erro de autorização. Favor revisar se o parâmetro Authorization esta sendo passado pelo header da requisição junto com o seu token de autenticação.

404

Endpoint não encontrado, favor revisar a URL utilizada.

Este erro também pode ocorrer caso algum parâmetro passado não esteja correto e assim a informação buscada não pode ser retornada.

500

Opa, algo de errado aconteceu! Tente sua requisição novamente. Caso o erro continue, entre em contato com suporte@idwall.co

5. Possíveis status que um relatório pode assumir

Status
Significado

PRE-PROCESSANDO

É o momento em que a imagem enviada esta 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

PRÉ-PROCESSANDO

Este status só é visto pelos clientes que utilizam o nosso OCR.

DEU VALID!!!

Quando um relatório assumir o status concluído e o parâmetro resultado vier como VALID , significa que todos os critérios da matriz utilizada foram cumpridos

DEU INVALID. E AGORA ?

Quando um relatório assumir o status concluído e o parâmetro resultado vier como status INVALID será necessário realizar uma validação manual, pois um ou mais critérios da matriz utilizada não foram cumpridos. Existem duas formas de realizar esta ação:

1º acessar a sua dashboard e localizar o relatório e fazer as validações necessárias

2º Utilizar a nossa rota de validação manual passando os parâmetros necessários.

 
Suggest Edits

Listagem de matrizes

Retorna todas as matrizes que estão cadastradas em sua conta

 
gethttps://api-v2.idwall.co/matrizes

Headers

Authorization
string
required

Token de autorização

 
curl -X GET https://api-v2.idwall.co/matrizes 
-H "Content-Type: application/json"
-H 'Authorization:seu-token'
A binary file was returned

You couldn't be authenticated

{
    "result": {
        "itens": [
            {
                "descricao": null,
                "nome": "consultaEmpresaDefault",
                "titulo": "Relatório padrão PJ",
                "creditos": 1
            },
            {
                "descricao": null,
                "nome": "consultaPessoaDefault",
                "titulo": "Relatório padrão PF",
                "creditos": 1
            },
            {
                "descricao": null,
                "nome": "consultaXPTO",
                "titulo": "Relatório XPTO",
                "creditos": 1
            }
        ]
    },
    "status_code": 200
}
{
    "error": "Unauthorized",
    "message": "Falha na autenticação. Por favor verifique o token utilizado e se o acesso foi liberado.",
    "status_code": 401
}
 
Suggest Edits

Detalhes matriz

Retorna todos os detalhes de uma matriz que esta cadastrada em sua conta

 
gethttps://api-v2.idwall.co/matrizes/matriz

Path Params

matriz
string
required

Nome da matriz que deseja obter os detalhes

Headers

Authorization
string
required

Token de autorização

 
curl -X GET https://api-v2.idwall.co/matrizes/nome_matriz 
-H "Content-Type: application/json"
-H 'Authorization:seu-token'
A binary file was returned

You couldn't be authenticated

{
  "result": {
    "descricao": null,
    "creditos": 1,
    "nome": "consultaPessoaDefault",
    "parametros": [
      {
        "nome": "cpf_data_de_nascimento",
        "requerido": true,
        "titulo": "Data de nascimento"
      },
      {
        "nome": "cpf_nome",
        "requerido": true,
        "titulo": "Nome completo"
      },
      {
        "nome": "cpf_numero",
        "requerido": true,
        "titulo": "CPF"
      }
    ],
    "regras": [
      {
        "descricao": "Não deve constar antecedentes criminais",
        "nome": "Antecedentes Criminais",
        "regras": [
          {
            "resultado": "nao_foi_possivel_emitir",
            "valor": "INVALID"
          },
          {
            "resultado": "error",
            "valor": "ERROR"
          },
          {
            "resultado": "n_a",
            "valor": "NO_DATA"
          },
          {
            "resultado": "nao_constam_antecedentes",
            "valor": "VALID"
          }
        ],
        "slug": "idwall.matrix.regras.antecedentes.RegraAntecedente"
      },
      {
        "descricao": "Nome deve ser igual ao cadastrado na Receita Federal",
        "nome": "Nome na Receita Federal",
        "regras": [
          {
            "resultado": "n_a",
            "valor": "NO_DATA"
          },
          {
            "resultado": "error",
            "valor": "ERROR"
          },
          {
            "resultado": "nome_como_o_da_receita_federal",
            "valor": "VALID"
          },
          {
            "resultado": "nome_diferente_da_receita_federal",
            "valor": "INVALID"
          }
        ],
        "slug": "idwall.matrix.regras.cpf.RegraNomeReceitaFederal"
      },
      {
        "descricao": "Não deve constar processos nos Tribunais de Justiça",
        "nome": "Processos nos Tribunais de Justiça",
        "regras": [
          {
            "resultado": "n_a",
            "valor": "NO_DATA"
          },
          {
            "resultado": "error",
            "valor": "ERROR"
          },
          {
            "resultado": "nenhum_processo_encontrado",
            "valor": "VALID"
          },
          {
            "resultado": "processo_encontrado",
            "valor": "INVALID"
          }
        ],
        "slug": "idwall.matrix.regras.processos.RegraProcessos"
      },
      {
        "descricao": "Não devem constar protestos",
        "nome": "Protestos",
        "regras": [
          {
            "resultado": "error",
            "valor": "ERROR"
          },
          {
            "resultado": "n_a",
            "valor": "NO_DATA"
          },
          {
            "resultado": "protesto_encontrado",
            "valor": "INVALID"
          },
          {
            "resultado": "nenhum_protesto_encontrado",
            "valor": "VALID"
          }
        ],
        "slug": "idwall.matrix.regras.protestos.RegraProtestos"
      },
      {
        "descricao": "Não deve constar registro de óbito na Receita Federal",
        "nome": "Registro de óbito na Receita Federal",
        "regras": [
          {
            "resultado": "possui_registro_de_obito",
            "valor": "INVALID"
          },
          {
            "resultado": "error",
            "valor": "ERROR"
          },
          {
            "resultado": "n_a",
            "valor": "NO_DATA"
          },
          {
            "resultado": "nao_possui_registro_de_obito",
            "valor": "VALID"
          }
        ],
        "slug": "idwall.matrix.regras.cpf.RegraObito"
      },
      {
        "descricao": "Situação cadastral do CPF deve ser REGULAR",
        "nome": "Situação Cadastral Regular",
        "regras": [
          {
            "resultado": "error",
            "valor": "ERROR"
          },
          {
            "resultado": "situacao_cadastral_regular",
            "valor": "VALID"
          },
          {
            "resultado": "situacao_cadastral_diferente_de_regular",
            "valor": "INVALID"
          },
          {
            "resultado": "n_a",
            "valor": "NO_DATA"
          }
        ],
        "slug": "idwall.matrix.regras.cpf.RegraSituacaoReceitaFederal"
      }
    ],
    "tipo": "Pessoa",
    "titulo": "Relatório padrão PF"
  },
  "status_code": 200
}
{
    "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": "Not Found",
    "status_code": 404
}
 
Suggest Edits

Listagem das pessoas consultadas

Retorna todas as pessoas consultadas por meio do seu token de autenticação

 
gethttps://api-v2.idwall.co/pessoas

Query Params

page
int32

Número de paginas

rows
int32

Número de linhas

Headers

Authorization
string
required

Token de autenticação

 
curl -X GET https://api-v2.idwall.co/pessoas 
-H "Content-Type: application/json"
-H 'Authorization:seu-token'
A binary file was returned

You couldn't be authenticated

{
  "result": {
    "busca": "",
    "itens": [
      {
        "cpf": "31071980687.",
        "nome": "Harry Thiago Potter",
        "atualizado_em": "2018-11-19T16:12:38.120Z"
      },
      {
        "cpf": "38190719790",
        "nome": "Hermione Jean Granger",
        "atualizado_em": "2018-11-19T20:37:26.285Z"
      },
      {
        "cpf": "38519800301",
        "nome": "Ronald Bílius Weasley",
        "atualizado_em": "2018-11-19T19:39:43.565Z"
      }
    ],
    "paginacao": {
      "atual": 1,
      "linhas": 25,
      "total": "3"
    }
  },
  "status_code": 200
}
{
    "error": "Unauthorized",
    "message": "Falha na autenticação. Por favor verifique o token utilizado e se o acesso foi liberado.",
    "status_code": 401
}
 
Suggest Edits

Detalhes de pessoas

Retorna uma pessoa em específico que foi consultada anteriormente por meio do seu token de autenticação

 
gethttps://api-v2.idwall.co/pessoas/cpf

Path Params

cpf
string
required

CPF da pessoa consultada anteriormente

Query Params

page
int32

Número de paginas que deseja ver

rows
int32

Número de linhas que deseja ver

Headers

Authorization
string
required

Token de autenticação

 
curl -X GET https://api-v2.idwall.co/pessoas/numero_do_cpf 
-H "Content-Type: application/json"
-H 'Authorization:seu-token'
A binary file was returned

You couldn't be authenticated

{
  "result": {
    "dados": {
      "atualizado_em": "2018-11-20T19:39:43.565Z",
      "cpf": "11081981006",
      "nome": "Ginevra Molly Weasley",
      "relatorios": [
        {
          "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "status": "CONCLUIDO",
          "nome": "Relatório padrão PF",
          "mensagem": "Válido.",
          "resultado": "VALID",
          "atualizado_em": "2018-11-19T19:39:43.565Z"
        },
        {
          "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "status": "CONCLUIDO",
          "nome": "Relatório padrão PF",
          "mensagem": "Válido",
          "resultado": "VALID",
          "atualizado_em": "2018-11-01T21:28:51.536Z"
        }
      ]
    },
    "paginacao": {
      "atual": 1,
      "linhas": 25,
      "total": "1"
    }
  },
  "status_code": 200
}
{
    "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":"Pessoa não encontrada",
  "status_code":404
}
 
Suggest Edits

Criar relatório pessoa física

Cria um relatório de pessoa física com os parâmetros enviados previamente

 
posthttps://api-v2.idwall.co/relatorios

Body Params

matriz
string
required

consultaPessoaDefault

parametros
object
required
parametros.cpf_nome
string
required

Nome do dono do CPF

parametros.cpf_numero
string
required

Número do CPF

parametros.cpf_data_de_nascimento
string
required

Data de nascimento do dono do CPF

Headers

Authorization
string
required

Token de autenticação

Ausência de dados

Quando um dado não é informado e ele é obrigatório, a nossa API enviará um status code 400 (bad request) informando que o dado está faltando.

Erro de digitação

Quando um dado é informado de maneira incorreta (CPF digitado não pertence a pessoa que deseja pesquisar) mas ele é um CPF válido o relatório será criado com base nas informações enviadas e realizará as checagens de acordo com a matriz que esta sendo utilizada.

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"
      	}
      }'
A binary file was returned

You couldn't be authenticated

{
    "result": {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "status_code": 200
}
{
    "error": "Bad Request",
    "message": "child \"parametros\" fails because [\"parametro_aleatorio\" is not allowed]",
    "validation": {
        "source": "payload",
        "keys": [
            "parametros.parametro_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
}
 
Suggest Edits

Criar relatório pessoa jurídica

Cria um relatório de pessoa jurídica com os parâmetros enviados previamente

 
posthttps://api-v2.idwall.co/relatorios

Body Params

matriz
string
required

consultaEmpresaDefault

parametros
object
required
parametros.cnpj_numero
string
required

Número do CNPJ da empresa

Headers

Authorization
string
required

Token de autenticação

Ausência de dados

Quando um dado não é informado e ele é obrigatório, a nossa API enviará um status code 400 (bad request) informando que o dado está faltando.

Erro de digitação

Quando um dado é informado de maneira incorreta (CNPJ digitado não pertence a entidade que deseja pesquisar), mas ele é um CNPJ válido o relatório será criado com base nas informações enviadas e realizará as checagens de acordo com a matriz que esta sendo utilizada.

curl -X POST https://api-v2.idwall.co/relatorios
-H "Content-Type: application/json"
-H 'Authorization:seu-token'
-d ' {
      	"matriz": "consultaEmpresaDefault",
        "parametros": {
          "cnpj_numero": "44137934280"
      	}
      }'
A binary file was returned

You couldn't be authenticated

{
    "result": {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    },
    "status_code": 200
}
{
    "error": "Bad Request",
    "message": "child \"parametros\" fails because [\"parametro_aleatorio\" is not allowed]",
    "validation": {
        "source": "payload",
        "keys": [
            "parametros.parametro_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
}
 
Suggest Edits

Obter status de um relatório

Esta rota obtém os dados de um relatório em específico.

 
gethttps://api-v2.idwall.co/relatorios/numero

Path Params

numero
string
required

Número identificador do relatório. Ex: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Headers

Authorization
string
required

Token de autorização

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

You couldn't be authenticated

{
    "result": {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "CONCLUIDO",
        "nome": "consultaPessoaDefault",
        "mensagem": "Válido.",
        "resultado": "VALID",
        "validado_em": "2018-11-18T19:34:46.815Z",
        "validado_por": null,
        "validado_manualmente": false,
        "atualizado_em": "2018-11-18T19:39:43.565Z",
        "criado_em": "2018-11-18T19:34:46.515Z",
        "criado_por": "Severo Snape"
    },
    "status_code": 200
}
{
    "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
}
 
Suggest Edits

Validação manual de relatório

Esta rota tem a função de validar ou invalidar um relatório manualmente

 
posthttps://api-v2.idwall.co/relatorios/validar/numero

Path Params

numero
string
required

Número identificador do relatório. Ex: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Body Params

aprovar
boolean
required
mensagem
string
required

Necessário ter mais de 25 caracteres explicando o motivo da aprovação ou da reprovação

Headers

Authorization
string
required

Token de autorização

 
curl -X POST https://api-v2.idwall.co/relatorios/validar/numero_relatorio
-H "Content-Type: application/json"
-H 'Authorization:seu-token'
-d '{
    "aprovar": true,
    "mensagem": "aprovo este relatório......."
}'
curl -X POST https://api-v2.idwall.co/relatorios/validar/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
-H "Content-Type: application/json"
-H 'Authorization:seu-token'
-d '{
    "aprovar": false,
    "mensagem": "reprovo este relatório.........."
}'
A binary file was returned

You couldn't be authenticated

{
  'result': 
  {
    'numero': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
  },
  'status_code': 200
}
{
  'result': 
  {
    'numero': 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
  },
  'status_code': 200
}
{
    "error": "Bad Request",
    "message": "child \"parametros\" fails because [\"parametro_aleatorio\" is not allowed]",
    "validation": {
        "source": "payload",
        "keys": [
            "parametros.parametro_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
}
{
    "error": "Not Found",
    "message": "Protocolo não encontrado.",
    "status_code": 404
}
 
Suggest Edits

Obter relatórios não concluídos

Esta rota obtém os relatórios que não foram concluídos até o momento

 
gethttps://api-v2.idwall.co/relatorios/pendentes

Headers

Authorization
string
required

Token de autenticação

Número de documento

Este parâmetro corresponde ao número de RG ou CPF que foi utilizado para realizar a consulta, como é possível criar diferentes relatórios com o mesmo RG ou CPF é normal aparecer o mesmo número de documento em relatórios diferentes.

 curl -X GET https://api-v2.idwall.co/relatorios/pendentes 
 -H "Content-Type: application/json" 
 -H 'Authorization:seu-token'
A binary file was returned

You couldn't be authenticated

{
  "result": {
    "itens": [
      {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "EM ANALISE",
        "tipo_pessoa": "Pessoa",
        "numero_documento": "52479790282",
        "atualizado_em": "2018-11-02T16:25:35.788Z"
      },
      {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "EM ANALISE",
        "tipo_pessoa": "Pessoa",
        "numero_documento": "52479790282",
        "atualizado_em": "2018-11-01T23:15:37.490Z"
      },
      {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "PRE-PROCESSANDO",
        "tipo_pessoa": "Pessoa",
        "numero_documento": "PRE-PROCESSANDO",
        "atualizado_em": "2018-11-27T19:01:11.001Z"
      }
    ],
    "paginacao": {
      "total": "3"
    }
  },
  "status_code": 200
}
{
  "error":"Unauthorized",
  "message":"Falha na autenticação. Por favor verifique o token utilizado e se o acesso foi liberado.",
  "status_code":401
}
 
Suggest Edits

Obter os parâmetros enviados em um relatorio

Está rota retorna os parâmetros enviados anteriormente para criação de um relatório

 
gethttps://api-v2.idwall.co/relatorios/numero/parametros

Path Params

numero
string
required

Número identificador do relatório. Ex: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Headers

Authorization
string
required

Token de autenticação

Campo parâmetros

O número de informações podem mudar, já que as matrizes utilizadas para realizar as consultas podem trazer diferentes parâmetros.

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

You couldn't be authenticated

{
    "result": {
        "atualizado_em": "2018-11-19T19:39:43.565Z",
        "mensagem": "Válido.",
        "nome": "consultaPessoaDefault",
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "parametros": {
            "cpf": "30071998002",
            "data_de_nascimento": "30/07/1980",
            "nome": "Neville Longbottom"
        },
        "resultado": "VALID",
        "status": "CONCLUIDO"
    },
    "status_code": 200
}
{
  "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
}
 
Suggest Edits

Obter dados das consultas de um relatório

Está rota retorna os dados mais específicos das consultas que foram realizadas para um relatório que foi criado anteriormente

 
gethttps://api-v2.idwall.co/relatorios/numero/consultas

Path Params

numero
string
required

Número identificador do relatório. Ex: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Headers

Authorization
string
required

Token de autenticação

Parâmetro consultas

O número de informações podem mudar, já que as matrizes podem utilizar fontes de consultas diferentes.

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

You couldn't be authenticated

{
  "result": {
    "nome_matriz": "consultaPessoaDefault",
    "status_protocolo": "CONCLUIDO",
    "consultas": [
      {
        "nome": "Protestos",
        "tentativas": [
          {
            "duracao_tentativa": 296.005,
            "hora_fim_tentativa": "2018-11-19T19:39:42.967Z",
            "hora_inicio_tentativa": "2018-11-19T19:34:46.962Z",
            "msg_erro_tentativa": "",
            "nome_fonte": "Protestos",
            "status_fonte": "OK",
            "status_tentativa": "SUCCESS",
            "tipo_erro_tentativa": null
          }
        ]
      },
      {
        "nome": "Antecedentes Federal",
        "tentativas": [
          {
            "duracao_tentativa": 4.575,
            "hora_fim_tentativa": "2018-11-19T19:34:51.538Z",
            "hora_inicio_tentativa": "2018-11-19T19:34:46.963Z",
            "msg_erro_tentativa": "",
            "nome_fonte": "Antecedentes Federal",
            "status_fonte": "OK",
            "status_tentativa": "SUCCESS",
            "tipo_erro_tentativa": null
          }
        ]
      },
      {
        "nome": "Processos SP",
        "tentativas": [
          {
            "duracao_tentativa": 4,
            "hora_fim_tentativa": "2018-11-19T19:34:50.986Z",
            "hora_inicio_tentativa": "2018-11-19T19:34:46.986Z",
            "msg_erro_tentativa": "",
            "nome_fonte": "Processos SP",
            "status_fonte": "OK",
            "status_tentativa": "SUCCESS",
            "tipo_erro_tentativa": null
          }
        ]
      },
      {
        "nome": "CPF Receita Federal",
        "tentativas": [
          {
            "duracao_tentativa": 1.896,
            "hora_fim_tentativa": "2018-11-19T19:34:48.859Z",
            "hora_inicio_tentativa": "2018-11-19T19:34:46.963Z",
            "msg_erro_tentativa": "",
            "nome_fonte": "CPF Receita Federal",
            "status_fonte": "OK",
            "status_tentativa": "SUCCESS",
            "tipo_erro_tentativa": null
          }
        ]
      }
    ]
  },
  "status_code": 200
}
{
  "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
}
 
Suggest Edits

Obter dados de um relatório

Está rota retorna os dados mais específicos de um relatório que foi criado anteriormente

 
gethttps://api-v2.idwall.co/relatorios/numero/dados

Path Params

numero
string
required

Número identificador do relatório. Ex: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Headers

Authorization
string
required

Token de autenticação

AVISO

O número de informações na resposta da API podem mudar, já que as matrizes podem utilizar fontes de consultas diferentes.

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

You couldn't be authenticated

{
  "result": {
    "atualizado_em": "2018-11-19T19:39:43.565Z",
    "criado_em": "2018-11-19T19:34:46.515Z",
    "mensagem": "Válido.",
    "nome": "consultaPessoaDefault",
    "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "resultado": "VALID",
    "status": "CONCLUIDO",
    "validado_em": "2018-11-19T19:34:46.815Z",
    "validado_manualmente": false,
    "certidoes_negativas": {
      "itens": [
        {
          "emitido_em": "2018-11-19T19:34:51.392971Z",
          "fonte": "AntecedentesPoliciaFederal",
          "protocolo": "46729702018",
          "url": null,
          "nada_consta": true
        }
      ]
    },
    "cpf": {
      "numero": "70195619700",
      "nome": "Minerva McGonagall",
      "data_de_nascimento": "04-10-1935",
      "cpf_situacao_cadastral": "REGULAR",
      "cpf_data_de_inscricao": "17-05-1965",
      "cpf_digito_verificador": "00",
      "cpf_anterior_1990": "S",
      "ano_obito": "",
      "grafias": [
        "MINERVA MCGONAGALL"
      ]
    },
    "processos": {
      "itens": []
    },
    "protestos": {
      "estados_sem_protestos": [
        "TO",
        "SE",
        "SP",
        "SC",
        "RR",
        "RO",
        "RS",
        "RN",
        "RJ",
        "PI",
        "PE",
        "PR",
        "PB",
        "PA",
        "MG",
        "MS",
        "MT",
        "MA",
        "GO",
        "ES",
        "DF",
        "CE",
        "BA",
        "AM",
        "AP",
        "AL",
        "AC"
      ]
    }
  },
  "status_code": 200
}
{
    "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
}
 
Suggest Edits

Obter todos os relatórios

Está rota retorna todos os relatórios que foram criados com o seu token de autenticação

 
gethttps://api-v2.idwall.co/relatorios

Query Params

page
string

Numero de paginas

rows
string

Numero de linhas

Headers

Authorization
string
required

Token de autenticação

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

You couldn't be authenticated

{
  "result": {
    "itens": [
      {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "PROCESSANDO",
        "tipo_pessoa": "Empresa",
        "nome": "Nome matriz",
        "atualizado_em": "2018-10-03T17:48:48.824Z",
        "resultado": null,
        "mensagem": "Validação Pendente.",
        "numero_documento": "xxxxxxxxxxxxxx"
      },
      {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "EM ANALISE",
        "tipo_pessoa": "Pessoa",
        "nome": "Nome matriz",
        "atualizado_em": "2018-10-03T17:45:44.476Z",
        "resultado": null,
        "mensagem": "Validação Pendente.",
        "numero_documento": "xxxxxxxxxxx"
      },
      {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "EM ANALISE",
        "tipo_pessoa": "Pessoa",
        "nome": "Nome matriz",
        "atualizado_em": "2018-10-03T17:32:16.857Z",
        "resultado": null,
        "mensagem": "Validação Pendente.",
        "numero_documento": "xxxxxxxxxxx"
      },
      {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "CONCLUIDO",
        "tipo_pessoa": "Empresa",
        "nome": "Nome matriz",
        "atualizado_em": "2018-10-03T16:43:00.572Z",
        "resultado": "VALID",
        "mensagem": "Válido.",
        "numero_documento": "xxxxxxxxxxxxxx"
      },
      {
        "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "CONCLUIDO",
        "tipo_pessoa": "Pessoa",
        "nome": "Nome matriz",
        "atualizado_em": "2018-10-03T14:53:57.413Z",
        "resultado": "VALID",
        "mensagem": "Válido.",
        "numero_documento": "xxxxxxxxxxx"
      }
    ],
    "paginacao": {
      "atual": 1,
      "linhas": 25,
      "total": 5
    }
  },
  "status_code": 200
}
{
  "error": "Unauthorized",
  "message": "Falha na autenticação. Por favor verifique o token utilizado e se o acesso foi liberado.",
  "status_code": 401
}
 
Suggest Edits

Obter regras de validação de um relatório

Está rota retorna as regras de validações que foram realizadas na criação de um relatório em específico

 
gethttps://api-v2.idwall.co/relatorios/numero/validacoes

Path Params

numero
string
required

Número identificador do relatório. Ex: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Headers

Authorization
string
required

Token de autenticação

 
curl -X GET https://api-v2.idwall.co/relatorios/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/validacoes 
-H "Content-Type: application/json" 
-H 'Authorization:seu-token'
A binary file was returned

You couldn't be authenticated

{
  "result": {
    "atualizado_em": "2018-10-19T19:39:43.565Z",
    "mensagem": "Válido.",
    "nome": "consultaPessoaDefault",
    "numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "resultado": "VALID",
    "status": "CONCLUIDO",
    "validacoes": [
      {
        "regra": "idwall.matrix.regras.cpf.RegraNomeReceitaFederal",
        "nome": "Nome na Receita Federal",
        "descricao": "Nome deve ser igual ao cadastrado na Receita Federal",
        "resultado": "VALID"
      },
      {
        "regra": "idwall.matrix.regras.protestos.RegraProtestos",
        "nome": "Protestos",
        "descricao": "Não devem constar protestos",
        "resultado": "VALID"
      },
      {
        "regra": "idwall.matrix.regras.cpf.RegraSituacaoReceitaFederal",
        "nome": "Situação Cadastral Regular",
        "descricao": "Situação cadastral do CPF deve ser REGULAR",
        "resultado": "VALID"
      },
      {
        "regra": "idwall.matrix.regras.antecedentes.RegraAntecedente",
        "nome": "Antecedentes Criminais",
        "descricao": "Não deve constar antecedentes criminais",
        "resultado": "VALID"
      },
      {
        "regra": "idwall.matrix.regras.cpf.RegraObito",
        "nome": "Registro de óbito na Receita Federal",
        "descricao": "Não deve constar registro de óbito na Receita Federal",
        "resultado": "VALID"
      },
      {
        "regra": "idwall.matrix.regras.processos.RegraProcessos",
        "nome": "Processos nos Tribunais de Justiça",
        "descricao": "Não deve constar processos nos Tribunais de Justiça",
        "resultado": "VALID"
      }
    ],
    "validado_em": "2018-09-19T19:34:46.815Z",
    "validado_manualmente": false,
    "validado_por": null
  },
  "status_code": 200
}
{
    "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
}
 
Suggest Edits

Obter status da API

Retorna o status atual da nossa API

 
gethttps://api-v2.idwall.co/status

Aviso de autenticação

Esta é a única rota da API da IDwall que não exige o envio do seu token de autenticação

curl -X GET https://api-v2.idwall.co/status 
-H "Content-Type: application/json"
A binary file was returned

You couldn't be authenticated

{
    "result": {
        "ambiente": "production",
        "ref": "production",
        "versao": "production"
    },
    "status_code": 200
}
 
Suggest Edits

Obter status das fontes utilizadas pela IDwall

Retorna o status das fontes utilizadas por nós

 
gethttps://api-v2.idwall.co/status/fontes

Headers

Authorization
string
required

Token de autenticação

O status das fontes podem variar de acordo com o tempo

DETRAN SP

O modo de consulta desta fonte foi alterada pelo próprio estado de São Paulo e com isso nosso sistema foi impossibilitado de realizar as consultas necessárias.

curl -X GET https://api-v2.idwall.co/status/fontes 
-H "Content-Type: application/json" 
-H 'Authorization:seu-token'
A binary file was returned

You couldn't be authenticated

{
  "result": [
    {
      "status": false,
      "fonte": "AntecedentesGO",
      "consultado_em": "2018-10-27T17:22:44.967Z"
    },
    {
      "status": false,
      "fonte": "CertidaoNegativaDebitosTributariosPF",
      "consultado_em": "2018-10-27T17:34:37.894Z"
    },
    {
      "status": false,
      "fonte": "CertidaoNegativaDebitosTributariosPJ",
      "consultado_em": "2018-10-27T17:34:19.618Z"
    },
    {
      "status": false,
      "fonte": "InfracoesDetranCE",
      "consultado_em": "2018-10-27T17:26:38.342Z"
    },
    {
      "status": false,
      "fonte": "InfracoesDetranSP",
      "consultado_em": "2018-10-27T17:22:45.473Z"
    },
    {
      "status": false,
      "fonte": "InfracoesDetranTO",
      "consultado_em": "2018-10-27T17:24:02.122Z"
    },
    {
      "status": false,
      "fonte": "ProcessosTJMA",
      "consultado_em": "2018-10-27T17:24:51.162Z"
    },
    {
      "status": false,
      "fonte": "RestituicaoReceitaFederal",
      "consultado_em": "2018-10-27T17:22:45.357Z"
    },
    {
      "status": false,
      "fonte": "SIAFI",
      "consultado_em": "2018-10-27T17:22:40.446Z"
    },
    {
      "status": false,
      "fonte": "SINESP",
      "consultado_em": "2018-10-27T17:26:00.454Z"
    },
    {
      "status": false,
      "fonte": "SintegraMSCAP",
      "consultado_em": "2018-10-27T17:23:07.097Z"
    },
    {
      "status": false,
      "fonte": "SintegraPR",
      "consultado_em": "2018-10-27T17:26:31.558Z"
    },
    {
      "status": false,
      "fonte": "VeiculoDetranSP",
      "consultado_em": "2018-10-27T17:22:41.585Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesAL",
      "consultado_em": "2018-10-27T17:35:56.845Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesAP",
      "consultado_em": "2018-10-27T17:37:14.480Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesBA",
      "consultado_em": "2018-10-27T17:36:11.438Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesCE",
      "consultado_em": "2018-10-27T17:36:50.927Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesDF",
      "consultado_em": "2018-10-27T17:15:35.663Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesES",
      "consultado_em": "2018-10-27T17:34:21.515Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesMA",
      "consultado_em": "2018-10-27T17:20:40.001Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesMG",
      "consultado_em": "2018-10-27T17:20:30.394Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesMS",
      "consultado_em": "2018-10-27T17:21:03.968Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesMT",
      "consultado_em": "2018-10-27T17:20:40.135Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesPA",
      "consultado_em": "2018-10-27T17:37:16.981Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesPE",
      "consultado_em": "2018-10-27T17:37:11.505Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesPI",
      "consultado_em": "2018-10-27T17:36:55.188Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesPoliciaCivilSP",
      "consultado_em": "2018-10-27T17:20:44.531Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesPoliciaFederal",
      "consultado_em": "2018-10-27T17:21:11.394Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesRJ",
      "consultado_em": "2018-10-27T17:35:36.288Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesRO",
      "consultado_em": "2018-10-27T17:36:31.714Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesRR",
      "consultado_em": "2018-10-27T17:35:59.400Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesRS",
      "consultado_em": "2018-10-27T17:35:51.534Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesSE",
      "consultado_em": "2018-10-27T17:36:09.878Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesTO",
      "consultado_em": "2018-10-27T17:35:01.325Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesTRF1",
      "consultado_em": "2018-10-27T17:35:18.766Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesTRF2",
      "consultado_em": "2018-10-27T17:35:17.425Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesTRF3",
      "consultado_em": "2018-10-27T17:35:50.896Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesTRF4",
      "consultado_em": "2018-10-27T17:35:36.843Z"
    },
    {
      "status": true,
      "fonte": "AntecedentesTRF5",
      "consultado_em": "2018-10-27T17:35:50.191Z"
    },
    {
      "status": true,
      "fonte": "AutenticidadeDetranSP",
      "consultado_em": "2018-10-27T17:20:43.314Z"
    },
    {
      "status": true,
      "fonte": "CADICON",
      "consultado_em": "2018-10-27T17:34:16.579Z"
    },
    {
      "status": true,
      "fonte": "CADIN",
      "consultado_em": "2018-10-27T17:35:39.134Z"
    },
    {
      "status": true,
      "fonte": "CADIRREG",
      "consultado_em": "2018-10-27T17:34:57.405Z"
    },
    {
      "status": true,
      "fonte": "CEISTransparencia",
      "consultado_em": "2018-10-27T17:34:26.136Z"
    },
    {
      "status": true,
      "fonte": "CEPIM",
      "consultado_em": "2018-11-27T17:34:19.611Z"
    },
    {
      "status": true,
      "fonte": "CertidaoDistribuicaoCriminalTJSP",
      "consultado_em": "2017-11-30T14:00:00.000Z"
    },
    {
      "status": true,
      "fonte": "CertidaoExecucaoCriminalTJSP",
      "consultado_em": "2017-11-30T14:00:00.000Z"
    },
    {
      "status": true,
      "fonte": "CertidaoNegativaDebitosTrabalhistas",
      "consultado_em": "2018-11-27T17:23:27.345Z"
    },
    {
      "status": true,
      "fonte": "CertidaoUnificadaCriminalTJAL",
      "consultado_em": "2018-11-19T16:51:30.000Z"
    },
    {
      "status": true,
      "fonte": "CertidaoUnificadaCriminalTJMA",
      "consultado_em": "2018-11-19T19:09:46.000Z"
    },
    {
      "status": true,
      "fonte": "CNEPTransparencia",
      "consultado_em": "2018-11-27T17:34:18.352Z"
    },
    {
      "status": true,
      "fonte": "CnhDenatran",
      "consultado_em": "2017-04-29T18:56:06.201Z"
    },
    {
      "status": true,
      "fonte": "CnhOrigem",
      "consultado_em": "2018-11-27T17:20:32.253Z"
    },
    {
      "status": true,
      "fonte": "CnpjReceitaFederal",
      "consultado_em": "2018-11-27T17:38:29.754Z"
    },
    {
      "status": true,
      "fonte": "COMPROT",
      "consultado_em": "2018-11-27T17:39:01.711Z"
    },
    {
      "status": true,
      "fonte": "ContasTCU",
      "consultado_em": "2018-11-27T17:36:44.336Z"
    },
    {
      "status": true,
      "fonte": "CpfReceitaFederal",
      "consultado_em": "2018-11-27T17:34:49.045Z"
    },
    {
      "status": true,
      "fonte": "DividaAtivaFazenda",
      "consultado_em": "2018-11-27T17:16:47.321Z"
    },
    {
      "status": true,
      "fonte": "EmpresaJucesp",
      "consultado_em": "2017-08-15T16:04:25.563Z"
    },
    {
      "status": true,
      "fonte": "EntidadeRNTRC",
      "consultado_em": "2018-11-27T17:38:36.825Z"
    },
    {
      "status": true,
      "fonte": "EUSanctions",
      "consultado_em": "2018-11-27T17:35:56.446Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranAC",
      "consultado_em": "2018-11-27T17:36:49.158Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranAL",
      "consultado_em": "2018-11-27T17:37:28.265Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranAM",
      "consultado_em": "2018-11-27T17:37:17.861Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranBA",
      "consultado_em": "2018-11-27T17:22:17.717Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranES",
      "consultado_em": "2018-11-27T17:34:47.373Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranMG",
      "consultado_em": "2018-11-27T17:23:03.504Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranMS",
      "consultado_em": "2018-11-27T17:38:53.628Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranMT",
      "consultado_em": "2018-11-27T17:38:54.156Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranPB",
      "consultado_em": "2018-11-27T17:35:52.229Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranPE",
      "consultado_em": "2018-11-27T17:16:35.303Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranPR",
      "consultado_em": "2018-11-27T17:35:40.784Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranRJ",
      "consultado_em": "2018-11-27T17:37:43.842Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranRN",
      "consultado_em": "2018-11-27T17:17:29.391Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranRO",
      "consultado_em": "2018-11-27T17:37:09.689Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranRR",
      "consultado_em": "2018-11-27T17:18:28.334Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranRS",
      "consultado_em": "2018-11-27T17:19:04.881Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranSC",
      "consultado_em": "2018-11-27T17:38:12.781Z"
    },
    {
      "status": true,
      "fonte": "InfracoesDetranSE",
      "consultado_em": "2018-11-27T17:38:24.548Z"
    },
    {
      "status": true,
      "fonte": "InfracoesMG",
      "consultado_em": "2018-11-27T17:34:22.199Z"
    },
    {
      "status": true,
      "fonte": "InfracoesPrefeituraSP",
      "consultado_em": "2018-11-27T17:22:40.405Z"
    },
    {
      "status": true,
      "fonte": "InfracoesRJ",
      "consultado_em": "2018-11-27T17:39:04.567Z"
    },
    {
      "status": true,
      "fonte": "InfracoesRS",
      "consultado_em": "2018-11-27T17:20:30.850Z"
    },
    {
      "status": true,
      "fonte": "JuntaComercialDF",
      "consultado_em": "2018-11-27T17:22:59.787Z"
    },
    {
      "status": true,
      "fonte": "JuntaComercialSP",
      "consultado_em": "2018-11-27T17:23:01.972Z"
    },
    {
      "status": true,
      "fonte": "MandadosPrisaoBancoNacional",
      "consultado_em": "2018-11-27T17:19:24.358Z"
    },
    {
      "status": true,
      "fonte": "MultasPoliciaRodoviariaFederal",
      "consultado_em": "2018-11-27T17:37:52.587Z"
    },
    {
      "status": true,
      "fonte": "NadaConstaVeiculoRJ",
      "consultado_em": "2018-11-27T17:21:07.188Z"
    },
    {
      "status": true,
      "fonte": "OFACSDN",
      "consultado_em": "2018-11-27T17:20:42.984Z"
    },
    {
      "status": true,
      "fonte": "PontosDetranRJService",
      "consultado_em": "2018-02-05T16:58:58.041Z"
    },
    {
      "status": true,
      "fonte": "ProcessosCVM",
      "consultado_em": "2018-11-27T17:21:25.336Z"
    },
    {
      "status": true,
      "fonte": "ProcessosSTF",
      "consultado_em": "2018-11-27T17:21:45.901Z"
    },
    {
      "status": true,
      "fonte": "ProcessosSTJ",
      "consultado_em": "2018-11-27T17:21:55.987Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJAC",
      "consultado_em": "2018-11-27T17:36:22.550Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJAL",
      "consultado_em": "2018-11-27T17:34:17.725Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJAM",
      "consultado_em": "2018-11-27T17:16:45.545Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJAP",
      "consultado_em": "2018-11-27T17:34:56.608Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJBA",
      "consultado_em": "2018-11-27T17:34:27.961Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJCE",
      "consultado_em": "2018-11-27T17:35:45.092Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJDF",
      "consultado_em": "2018-11-27T17:35:35.892Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJES",
      "consultado_em": "2018-11-27T17:35:27.751Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJGO",
      "consultado_em": "2018-11-27T17:37:12.073Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJMG",
      "consultado_em": "2018-11-27T17:21:01.037Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJMS",
      "consultado_em": "2018-11-27T17:22:44.820Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJMT",
      "consultado_em": "2018-11-27T17:22:21.858Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJPA",
      "consultado_em": "2018-11-27T17:21:46.232Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJPB",
      "consultado_em": "2018-11-27T17:22:14.744Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJPE",
      "consultado_em": "2018-11-27T17:21:01.880Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJPI",
      "consultado_em": "2018-11-27T17:21:11.985Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJPR",
      "consultado_em": "2018-11-27T17:24:54.982Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJRJ",
      "consultado_em": "2018-11-27T17:34:25.055Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJRJ99",
      "consultado_em": "2017-06-26T16:37:42.494Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJRN",
      "consultado_em": "2018-11-27T17:34:21.780Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJRO",
      "consultado_em": "2018-11-27T17:35:48.733Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJRR",
      "consultado_em": "2018-11-27T17:35:19.227Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJRS",
      "consultado_em": "2018-11-27T17:35:34.963Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJSC",
      "consultado_em": "2018-11-27T17:35:28.846Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJSE",
      "consultado_em": "2018-11-27T17:34:39.321Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJSP",
      "consultado_em": "2018-11-27T17:35:16.355Z"
    },
    {
      "status": true,
      "fonte": "ProcessosTJTO",
      "consultado_em": "2018-11-27T17:37:13.819Z"
    },
    {
      "status": true,
      "fonte": "ProtestosIEPTB",
      "consultado_em": "2018-11-27T17:37:38.472Z"
    },
    {
      "status": true,
      "fonte": "RegularidadeFgtsCaixa",
      "consultado_em": "2018-11-27T17:20:13.398Z"
    },
    {
      "status": true,
      "fonte": "SintegraAC",
      "consultado_em": "2018-11-27T17:36:49.912Z"
    },
    {
      "status": true,
      "fonte": "SintegraAL",
      "consultado_em": "2018-11-27T17:37:38.760Z"
    },
    {
      "status": true,
      "fonte": "SintegraAM",
      "consultado_em": "2018-11-27T17:38:10.932Z"
    },
    {
      "status": true,
      "fonte": "SintegraAP",
      "consultado_em": "2018-11-27T17:37:44.951Z"
    },
    {
      "status": true,
      "fonte": "SintegraBA",
      "consultado_em": "2018-11-27T17:38:40.403Z"
    },
    {
      "status": true,
      "fonte": "SintegraCE",
      "consultado_em": "2018-11-27T17:20:40.837Z"
    },
    {
      "status": true,
      "fonte": "SintegraDF",
      "consultado_em": "2018-11-27T17:20:14.314Z"
    },
    {
      "status": true,
      "fonte": "SintegraES",
      "consultado_em": "2018-11-27T17:20:13.591Z"
    },
    {
      "status": true,
      "fonte": "SintegraGO",
      "consultado_em": "2018-11-27T17:20:43.735Z"
    },
    {
      "status": true,
      "fonte": "SintegraMA",
      "consultado_em": "2018-11-27T17:34:38.527Z"
    },
    {
      "status": true,
      "fonte": "SintegraMG",
      "consultado_em": "2018-11-27T17:34:28.549Z"
    },
    {
      "status": true,
      "fonte": "SintegraMSCCI",
      "consultado_em": "2018-11-27T17:20:53.034Z"
    },
    {
      "status": true,
      "fonte": "SintegraMT",
      "consultado_em": "2018-11-27T17:34:41.539Z"
    },
    {
      "status": true,
      "fonte": "SintegraPA",
      "consultado_em": "2018-11-27T17:36:03.084Z"
    },
    {
      "status": true,
      "fonte": "SintegraPB",
      "consultado_em": "2018-11-27T17:23:33.816Z"
    },
    {
      "status": true,
      "fonte": "SintegraPE",
      "consultado_em": "2018-11-27T17:20:36.467Z"
    },
    {
      "status": true,
      "fonte": "SintegraPI",
      "consultado_em": "2018-11-27T17:38:16.639Z"
    },
    {
      "status": true,
      "fonte": "SintegraRJ",
      "consultado_em": "2018-11-27T17:38:58.771Z"
    },
    {
      "status": true,
      "fonte": "SintegraRN",
      "consultado_em": "2018-11-27T17:38:53.039Z"
    },
    {
      "status": true,
      "fonte": "SintegraRO",
      "consultado_em": "2018-11-27T17:38:42.873Z"
    },
    {
      "status": true,
      "fonte": "SintegraRR",
      "consultado_em": "2018-11-27T17:38:38.217Z"
    },
    {
      "status": true,
      "fonte": "SintegraRS",
      "consultado_em": "2018-11-27T17:38:52.228Z"
    },
    {
      "status": true,
      "fonte": "SintegraSC",
      "consultado_em": "2018-11-27T17:22:23.629Z"
    },
    {
      "status": true,
      "fonte": "SintegraSE",
      "consultado_em": "2018-11-27T17:39:01.438Z"
    },
    {
      "status": true,
      "fonte": "SintegraSP",
      "consultado_em": "2018-11-27T17:38:19.007Z"
    },
    {
      "status": true,
      "fonte": "SintegraTO",
      "consultado_em": "2018-11-27T17:23:59.110Z"
    },
    {
      "status": true,
      "fonte": "SituacaoMEI",
      "consultado_em": "2018-11-27T17:37:54.082Z"
    },
    {
      "status": true,
      "fonte": "SMTCondutoresMotoFrete",
      "consultado_em": "2018-11-27T17:35:50.398Z"
    },
    {
      "status": true,
      "fonte": "SSDMEC",
      "consultado_em": "2018-11-27T17:38:39.171Z"
    },
    {
      "status": true,
      "fonte": "TRTSP",
      "consultado_em": "2018-11-27T17:36:44.010Z"
    },
    {
      "status": true,
      "fonte": "UNSanctions",
      "consultado_em": "2018-11-27T17:21:15.782Z"
    },
    {
      "status": true,
      "fonte": "VeiculoDenatran",
      "consultado_em": "2017-05-02T16:31:11.306Z"
    },
    {
      "status": true,
      "fonte": "VeiculoRNTRC",
      "consultado_em": "2018-11-27T17:38:00.916Z"
    }
  ],
  "status_code": 200
}
{
    "error": "Unauthorized",
    "message": "Falha na autenticação. Por favor verifique o token utilizado e se o acesso foi liberado.",
    "status_code": 401
}
 
Suggest Edits

Obter o status da fonte por matriz

retorna o status das fontes utilizadas por uma determinada matriz.

 
gethttps://api-v2.idwall.co/status/fontes/matriz

Path Params

matriz
string
required

Nome da matriz que deseja consultar as fontes

Headers

Authorization
string
required

Token de autenticação

O resultado varia conforme a matriz utilizada para realizar a consulta

curl -X GET https://api-v2.idwall.co/status/fontes/nome_da_matriz 
-H "Content-Type: application/json" 
-H 'Authorization:seu-token'
A binary file was returned

You couldn't be authenticated

{
    "result": [
        {
            "status": true,
            "fonte": "AntecedentesPoliciaFederal",
            "consultado_em": "2018-11-27T19:19:03.148Z"
        },
        {
            "status": true,
            "fonte": "CpfReceitaFederal",
            "consultado_em": "2018-11-27T19:14:33.256Z"
        },
        {
            "status": true,
            "fonte": "ProcessosTJSP",
            "consultado_em": "2018-11-27T19:14:25.635Z"
        },
        {
            "status": true,
            "fonte": "ProtestosIEPTB",
            "consultado_em": "2018-11-27T19:15:23.525Z"
        }
    ],
    "status_code": 200
}
{
    "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": "Not Found",
    "status_code": 404
}
 
Suggest Edits

Detalhar perfil do usuario

Retorna todos os dados de sua conta

 
gethttps://api-v2.idwall.co/usuario

Headers

Authorization
string
required

Token de autenticação

Aviso

Esta rota possui dados sensíveis, não divulgue as informações que são retornadas por ela, pois esta ação pode comprometer sua integração com o nosso sistema e lhe expor a ataques cibernéticos

curl -X GET https://api-v2.idwall.co/usuario 
-H "Content-Type: application/json"
-H 'Authorization:seu-token'
A binary file was returned

You couldn't be authenticated

{
  "result": {
    "api_token": "seu token",
    "email": "tom.riddle@idwall.co",
    "nome_usuario": "Tom Marvolo Riddle",
    "webhook_url": "https://darkMark.deathEaters.io",
    "nome_organizacao": "IDwall",
    "id_organizacao": "7"
  },
  "status_code": 200
}
{
    "error": "Unauthorized",
    "message": "Falha na autenticação. Por favor verifique o token utilizado e se o acesso foi liberado.",
    "status_code": 401
}