{"info":{"_postman_id":"685e776a-df46-4d42-b016-95dad37bcedc","name":"IDwall API v2","description":"

Esta é a nossa documentação da APIv2 da IDwall.

Todos os nossos endpoints seguem um padrão de resultado de consulta.

Todos as consultas que executam com sucesso retornam o HTTP Status 200.

Todas as consultas retornam conteúdos JSON (application/json) e possuem corpos padrões:

Requisições de sucesso

{\n    \"status_code\": 200,\n    \"result\": { }\n}\n

Requisições falhas

{\n    \"status_code\": 404,\n    \"error\": \"Not Found\",\n    \"message\": \"O protocolo requisitado não foi encontrado.\"\n}\n

Cada endpoint possui um schema diferente para o campo result, que poderá ser consultado\nconforme necessidade no decorrer da documentação.

Uso da API

Para implementação da API em seu sitema, selecione na coluna ao lado a linguagem de programação que gostaria de usar para fazer requisições aos endpoints. Códigos de exemplo serão gerados ao lado de cada endpoint para auxiliá-lo na implementação.

Para uma implementação alternativa da API, utilize o Postman importando a Collection da IDwall usando o menu Import > Import from Link > https://api-v2.idwall.co/metadata.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3967924","collectionId":"685e776a-df46-4d42-b016-95dad37bcedc","publishedId":"RW1dEx9b","public":true,"customColor":null,"publishDate":"2018-05-01T17:20:40.000Z"},"item":[{"name":"Empresas","item":[{"name":"Listar empresas","id":"6009d26f-0d13-4163-87dd-64dd4b2b22d1","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/empresas?busca=string&page=1&rows=25","description":"

O endpoint de /empresas lista todas as empresas que foram consultadas no sistema. Retornando uma listagem com limite de acordo com o determinado no parâmetro de Querystring.

Parâmetros de entrada

Para esta requisição, basta enviar o Token no Header como Authorization e, caso precise alterar os parâmetros de paginação, usar o valores page e rows (os valores padrões são 1 e 25, respectivamente):

/empresas?page=1&rows=50\n

Exemplo de retorno de sucesso

{\n    \"status_code\": \"200\",\n    \"result\": {\n        \"busca\": \"\",\n        \"paginacao\": {\n            \"atual\": 1,\n            \"linhas\": 25,\n            \"total\": 96\n        },\n        \"itens\": [\n            {\n                \"cnpj\": \"11122223000333\",\n                \"nome\": \"EMPRESAS DISTRIBUIDORAS LTDA\",\n                \"atualizado_em\": \"2017-03-07T18:05:47.548Z\"\n            }\n        ]\n    }\n}\n

Exemplo de retorno de erro

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

\n","urlObject":{"protocol":"https","path":["empresas"],"host":["api-v2","idwall","co"],"query":[{"key":"busca","value":"string"},{"key":"page","value":"1"},{"key":"rows","value":"25"}],"variable":[]}},"response":[],"_postman_id":"6009d26f-0d13-4163-87dd-64dd4b2b22d1"},{"name":"Detalhar empresa","id":"ead986b0-d89d-4173-bfa1-731c1d126730","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/empresas/:cnpj?page=1&rows=25","description":"

Utilizando o endpoint /empresas/{cnpj} você poderá obter informações gerais de todos os protocolos relacionados à determinado CNPJ.

Parâmetros de entrada

Para esta requisição, envie o Token no Header como Authorization, o CNPJ na própria URL e, caso precise alterar os parâmetros de paginação, usar o valores page e rows (os valores padrões são 1 e 25, respectivamente):

/empresas/11122223000333?page=1&rows=50\n

Exemplo de retorno de sucesso

{\n    \"status_code\": \"200\",\n    \"result\": {\n        \"busca\": \"\",\n        \"paginacao\": {\n            \"atual\": 1,\n            \"linhas\": 25,\n            \"total\": 1\n        },\n        \"dados\": {\n            \"cnpj\": \"11122223000333\",\n            \"nome\": \"EMPRESAS DISTRIBUIDORAS LTDA\",\n            \"atualizado_em\": \"2017-03-07T18:12:55.555Z\",\n            \"relatorios\": [\n                {\n                    \"numero\": \"88888888-3333-aabc-1b4a-999333aaa987\",\n                    \"status\": \"concluido\",\n                    \"nome\": \"consultaEmpresaDefault\",\n                    \"mensagem\": \"Válido. Não consta dívida ativa na Fazenda\",\n                    \"resultado\": \"VALID\",\n                    \"atualizado_em\": \"2017-03-07T18:12:55.555Z\"\n                }\n            ]\n        }\n    }\n}\n

Exemplo de retorno de erro

{\n  \"error\": \"Not Found\",\n  \"message\": \"Empresa não encontrada\",\n  \"status_code\": 404\n}\n

\n","urlObject":{"protocol":"https","path":["empresas",":cnpj"],"host":["api-v2","idwall","co"],"query":[{"key":"page","value":"1"},{"key":"rows","value":"25"}],"variable":[{"id":"cnpj","type":"any","value":"12345678000123","key":"cnpj"}]}},"response":[],"_postman_id":"ead986b0-d89d-4173-bfa1-731c1d126730"}],"id":"a4cd75ac-8ee3-4dd8-be3f-041255ef7d7d","description":"

Empresa é a entidade associada à consultas feitas para Pessoas Jurídicas no sistema da IDwall.

Nos endpoints a seguir você pode verificar como consultar CNPJ's com relatórios já enviados pelo seu usuário no sistema IDwall.

\n","_postman_id":"a4cd75ac-8ee3-4dd8-be3f-041255ef7d7d"},{"name":"Matrizes","item":[{"name":"Listar matrizes","id":"bcf408fd-f1cc-454c-9b12-b248fc7cc49d","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/matrizes","description":"

O endpoint de /matrizes lista todas as matrizes disponíveis para seu usuário.

Parâmetros de entrada

Para esta requisição, basta enviar o Token no Header como Authorization

/matrizes\n

Exemplo de retorno de sucesso

{\n  \"status_code\": 200,\n  \"result\": {\n    \"itens\": [\n      {\n        \"descricao\": \"Consulta CNH\",\n        \"nome\": \"consultaCNH\"\n      },\n      {\n        \"descricao\": \"Consulta Empresa\",\n        \"nome\": \"consultaEmpresa\"\n      },\n      {\n        \"descricao\": \"Consulta Pessoa\",\n        \"nome\": \"consultaPessoa\"\n      }\n    ]\n  }\n}\n

\n","urlObject":{"protocol":"https","path":["matrizes"],"host":["api-v2","idwall","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"bcf408fd-f1cc-454c-9b12-b248fc7cc49d"},{"name":"Detalhar matriz","id":"2ded83e8-6fe4-4e7b-ac87-c51c7d37e5ed","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/matrizes/:matriz","description":"

Utilizando o endpoint /matrizes/{matriz} você poderá obter informações sobre determinada matriz e quais parâmetros devem ser enviados ao solicitar novas consultas de relatórios.

Os parâmetros marcados como requerido devem ser obrigatoriamente enviados na requisição POST de /relatorios, use a chave nome para enviar os respectivos valores.

A chave Regras contém as regras de validação que serão usadas para pontuar determinado Relatório assim que todos os dados forem consultados.

Parâmetros de entrada

Para esta requisição, envie o Token no Header como Authorization, o nome da matriz na própria URL (adquirido no endpoint /matrizes).

/matrizes/consultacpf\n

Exemplo de retorno de sucesso

{\n  \"status_code\": 200,\n  \"result\": {\n    \"descricao\": \"Consulta CPF\",\n    \"nome\": \"consultaCPF\",\n    \"regras\": [\n      {\n        \"descricao\": \"Não deve constar antecedentes criminais\",\n        \"nome\": \"Antecedentes Criminais\",\n        \"regras\": [\n          {\n            \"resultado\": \"error\",\n            \"valor\": \"ERROR\"\n          },\n          {\n            \"resultado\": \"nao_foi_possivel_emitir\",\n            \"valor\": \"INVALID\"\n          },\n          {\n            \"resultado\": \"nao_constam_antecedentes\",\n            \"valor\": \"VALID\"\n          },\n          {\n            \"resultado\": \"n_a\",\n            \"valor\": \"NO_DATA\"\n          }\n        ]\n      },\n      {\n        \"descricao\": \"Verifica se está na blacklist CEIS\",\n        \"nome\": \"CEIS (Cadastro de Empresas Inidôneas e Suspensas)\",\n        \"regras\": [\n          {\n            \"resultado\": \"listado\",\n            \"valor\": \"INVALID\"\n          },\n          {\n            \"resultado\": \"error\",\n            \"valor\": \"ERROR\"\n          },\n          {\n            \"resultado\": \"n_a\",\n            \"valor\": \"NO_DATA\"\n          },\n          {\n            \"resultado\": \"nao_listado\",\n            \"valor\": \"VALID\"\n          }\n        ]\n      }\n    ],\n    \"parametros\": [\n      {\n        \"nome\": \"cpf_numero\",\n        \"requerido\": true,\n        \"titulo\": \"Número do CPF\"\n      },\n      {\n        \"nome\": \"cpf_nome\",\n        \"requerido\": true,\n        \"titulo\": \"Nome completo\"\n      },\n      {\n        \"nome\": \"cpf_data_nascimento\",\n        \"requerido\": false,\n        \"titulo\": \"Data de nascimento\"\n      }\n    ]\n  }\n}\n

Exemplo de retorno de erro

{\n  \"error\": \"Not Found\",\n  \"message\": \"Matriz não encontrada.\",\n  \"status_code\": 404\n}\n

\n","urlObject":{"protocol":"https","path":["matrizes",":matriz"],"host":["api-v2","idwall","co"],"query":[],"variable":[{"id":"matriz","type":"any","value":"","key":"matriz"}]}},"response":[],"_postman_id":"2ded83e8-6fe4-4e7b-ac87-c51c7d37e5ed"}],"id":"7e6fbef5-836f-4591-86e4-0369d4059ee0","description":"

A Matriz define quais dados serão buscados ao solicitar um novo relatório e como eles devem ser validados após as consultas serem finalizadas.

Uma matriz de validação pode retornar um score (ex: 0-100) ou um status (ex: válido/inválido).

Seu usuário na IDwall terá matrizes pertinentes ao seu modelo de negócio, aos dados que necessita extrair de pessoas ou empresas e podem ser alteradas (consulte seu contrato e caso seja necessário, entre em contato por e-mail).

Nos endpoints a seguir podem ser consultados mais detalhes das matrizes que foram atribuídas ao seu usuário na IDwall.

Os dados a seguir também podem ser consultados pela Dashboard IDwall no menu Matrizes.

\n","_postman_id":"7e6fbef5-836f-4591-86e4-0369d4059ee0"},{"name":"Pessoas","item":[{"name":"Listar pessoas","id":"e1425b78-cdbc-4bac-9071-3e9ef85e1eb5","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/pessoas?busca=string&page=1&rows=25","description":"

O endpoint de /pessoas lista todas as pessoas que foram consultadas no sistema. Retornando uma listagem com limite de acordo com o determinado no parâmetro de Querystring.

Parâmetros de entrada

/pessoas?page=1&rows=50\n

Exemplo de retorno de sucesso

{\n    \"status_code\": \"200\",\n    \"result\": {\n        \"busca\": \"\",\n        \"paginacao\": {\n            \"atual\": 1,\n            \"linhas\": 25,\n            \"total\": 2\n        },\n        \"itens\": [\n            {\n                \"cpf\": \"00011122233\",\n                \"nome\": \"João Silveira\",\n                \"atualizado_em\": \"2017-03-03T03:40:04.264Z\"\n            },\n            {\n                \"cpf\": \"11144455599\",\n                \"nome\": \"Maria dos Santos\",\n                \"atualizado_em\": \"2016-11-28T23:26:40.599Z\"\n            }\n        ]\n    }\n}\n

Exemplo de retorno de erro

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

\n","urlObject":{"protocol":"https","path":["pessoas"],"host":["api-v2","idwall","co"],"query":[{"key":"busca","value":"string"},{"key":"page","value":"1"},{"key":"rows","value":"25"}],"variable":[]}},"response":[],"_postman_id":"e1425b78-cdbc-4bac-9071-3e9ef85e1eb5"},{"name":"Detalhar pessoa","id":"92610316-1045-4256-8388-98b26ab7ef3f","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/pessoas/:cpf?page=1&rows=25","description":"

Utilizando o endpoint /pessoas/{cpf} você poderá obter informações gerais de todos os protocolos relacionados à determinado CPF.

Parâmetros de entrada

Para esta requisição, envie o Token no Header como Authorization, o CPF na própria URL e, caso precise alterar os parâmetros de paginação, usar o valores page e rows (os valores padrões são 1 e 25, respectivamente):

/pessoas/99977766612?page=1&rows=50\n

Exemplo de retorno de sucesso

{\n    \"status_code\": \"200\",\n    \"result\": {\n        \"busca\": \"\",\n        \"paginacao\": {\n            \"atual\": 1,\n            \"linhas\": 25,\n            \"total\": 1\n        },\n        \"dados\": {\n            \"cpf\": \"11123456700\",\n            \"nome\": \"Lúcio Gonçalves\",\n            \"atualizado_em\": \"2017-03-03T03:17:14.980Z\",\n            \"relatorios\": [\n                {\n                    \"numero\": \"00000000-111-aaaa-hhhh-333444455555\",\n                    \"status\": \"concluido\",\n                    \"nome\": \"consultaPessoaDefault\",\n                    \"mensagem\": \"Obteve um resultado positivo durante a validação.\",\n                    \"resultado\": \"VALID\",\n                    \"atualizado_em\": \"2017-03-03T03:17:14.980Z\"\n                }\n            ]\n        }\n    }\n}\n

Exemplo de retorno de erro

{\n  \"error\": \"Bad Request\",\n  \"message\": \"child \\\"cpf\\\" fails because [\\\"cpf\\\" length must be 11 characters long]\",\n  \"validation\": {\n    \"source\": \"params\",\n    \"keys\": [\n      \"cpf\"\n    ]\n  },\n  \"status_code\": 400\n}\n

\n","urlObject":{"protocol":"https","path":["pessoas",":cpf"],"host":["api-v2","idwall","co"],"query":[{"key":"page","value":"1"},{"key":"rows","value":"25"}],"variable":[{"id":"cpf","type":"any","value":"00000000000","key":"cpf"},{"type":"any","value":"0"},{"type":"any","value":"0","key":1},{"type":"any","value":"0","key":2},{"type":"any","value":"0","key":3},{"type":"any","value":"0","key":4},{"type":"any","value":"0","key":5},{"type":"any","value":"0","key":6},{"type":"any","value":"0","key":7},{"type":"any","value":"0","key":8},{"type":"any","value":"0","key":9},{"type":"any","value":"0","key":10}]}},"response":[],"_postman_id":"92610316-1045-4256-8388-98b26ab7ef3f"}],"id":"5eea112e-509f-4431-a575-dd624cf0135d","description":"

Pessoa é a entidade associada à consultas feitas para Pessoas Físicas no sistema da IDwall.

Nos endpoints a seguir você pode verificar como consultar CPF's com relatórios já enviados pelo seu usuário no sistema IDwall.

\n","_postman_id":"5eea112e-509f-4431-a575-dd624cf0135d"},{"name":"Relatórios","item":[{"name":"Listar relatórios","id":"2a47aae2-544b-48fa-a74d-56c1c1ee8fae","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/relatorios?page=1&rows=25","description":"

Ao fazer uma requisição do tipo GET para o endpoint de /relatorios você terá acesso à todos os relatórios gerados por protocolos de consulta na plataforma. É retornada uma listagem com limite de acordo com o determinado no parâmetro de Querystring.

Parâmetros de entrada

/relatorios?page=1&rows=50\n

Exemplo de retorno de sucesso

{\n    \"status_code\": 200,\n    \"result\": {\n        \"busca\": \"\",\n        \"paginacao\": {\n            \"atual\": 1,\n            \"linhas\": 25,\n            \"total\": 1\n        },\n        \"itens\": [\n            {\n                \"numero\": \"99988855-0000-aaaa-abcd-123456789012\",\n                \"status\": \"pendente\",\n                \"tipo_pessoa\": \"Pessoa\",\n                \"numero_documento\": \"11122299900\",\n                \"nome\": \"consultaPessoaDefault\",\n                \"mensagem\": \"Relatório enviado para processamento.\",\n                \"resultado\": null,\n                \"atualizado_em\": \"2017-03-20T17:49:20.000Z\"\n            }\n        ]\n    }\n}\n

Exemplo de retorno de erro

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

\n","urlObject":{"protocol":"https","path":["relatorios"],"host":["api-v2","idwall","co"],"query":[{"key":"page","value":"1"},{"key":"rows","value":"25"}],"variable":[]}},"response":[],"_postman_id":"2a47aae2-544b-48fa-a74d-56c1c1ee8fae"},{"name":"Relatórios não concluídos","id":"d3f8e382-1da3-42f9-828b-1f0ce444f2b8","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/relatorios/pendentes?page=1&rows=25","description":"

Enquanto os relatórios não estiverem concluídos, você pode consultá-los no endpoint de /relatorios/pendentes e acessar uma lista com todos os relatórios com status diferente de Concluído.

Parâmetros de entrada

Para esta requisição, envie o Token no Header como Authorization e, caso precise alterar os parâmetros de paginação, usar o valores page e rows (os valores padrões são 1 e 25, respectivamente):

/relatorios/pendentes/?page=1&rows=50\n

Exemplo de retorno de sucesso

{\n    \"status_code\": 200,\n    \"result\": {\n        \"busca\": \"\",\n        \"paginacao\": {\n            \"atual\": 1,\n            \"linhas\": 25,\n            \"total\": 1\n        },\n        \"itens\": [\n            {\n                \"numero\": \"99988855-0000-aaaa-abcd-123456789012\",\n                \"status\": \"pendente\",\n                \"tipo_pessoa\": \"Pessoa\",\n                \"numero_documento\": \"11122233388\",\n                \"atualizado_em\": \"2017-03-20T17:49:20.000Z\"\n            }\n        ]\n    }\n}\n

Exemplo de retorno de erro

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

\n","urlObject":{"protocol":"https","path":["relatorios","pendentes"],"host":["api-v2","idwall","co"],"query":[{"key":"page","value":"1"},{"key":"rows","value":"25"}],"variable":[]}},"response":[],"_postman_id":"d3f8e382-1da3-42f9-828b-1f0ce444f2b8"},{"name":"Detalhar relatório","id":"7a1411f2-31ff-4f66-a780-02a164c7ca32","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/relatorios/:numero","description":"

Para informações de um relatório específico use o endpoint /relatorios/{numero} e obtenha informações sobre determinado protocolo gerado pela plataforma.

Parâmetros de entrada

Para esta requisição, envie o Token no Header como Authorization e o número do protocolo na própria URL:

/relatorios/99988855-0000-aaaa-abcd-123456789012\n

Exemplo de retorno de sucesso

{\n    \"status_code\": 200,\n    \"result\": {\n        \"atualizado_em\": \"2017-03-20T17:49:20.000Z\",\n        \"mensagem\": null,\n        \"nome\": \"consultaPessoaDefault\",\n        \"numero\": \"99988855-0000-aaaa-abcd-123456789012\",\n        \"resultado\": null,\n        \"status\": \"pendente\"\n    }\n}\n

Exemplo de retorno de erro

{\n    \"error\": \"Not Found\",\n    \"message\": \"Protocolo não encontrado.\",\n    \"status_code\": 404\n}\n

\n","urlObject":{"protocol":"https","path":["relatorios",":numero"],"host":["api-v2","idwall","co"],"query":[],"variable":[{"id":"numero","type":"any","value":"00000000-0000-0000-0000-000000000000","key":"numero"},{"type":"any","value":"0"},{"type":"any","value":"0","key":1},{"type":"any","value":"0","key":2},{"type":"any","value":"0","key":3},{"type":"any","value":"0","key":4},{"type":"any","value":"0","key":5},{"type":"any","value":"0","key":6},{"type":"any","value":"0","key":7},{"type":"any","value":"-","key":8},{"type":"any","value":"0","key":9},{"type":"any","value":"0","key":10},{"type":"any","value":"0","key":11},{"type":"any","value":"0","key":12},{"type":"any","value":"-","key":13},{"type":"any","value":"0","key":14},{"type":"any","value":"0","key":15},{"type":"any","value":"0","key":16},{"type":"any","value":"0","key":17},{"type":"any","value":"-","key":18},{"type":"any","value":"0","key":19},{"type":"any","value":"0","key":20},{"type":"any","value":"0","key":21},{"type":"any","value":"0","key":22},{"type":"any","value":"-","key":23},{"type":"any","value":"0","key":24},{"type":"any","value":"0","key":25},{"type":"any","value":"0","key":26},{"type":"any","value":"0","key":27},{"type":"any","value":"0","key":28},{"type":"any","value":"0","key":29},{"type":"any","value":"0","key":30},{"type":"any","value":"0","key":31},{"type":"any","value":"0","key":32},{"type":"any","value":"0","key":33},{"type":"any","value":"0","key":34},{"type":"any","value":"0","key":35}]}},"response":[],"_postman_id":"7a1411f2-31ff-4f66-a780-02a164c7ca32"},{"name":"Relatório dados","id":"93067a8c-5193-4025-91e5-62d81de4e99a","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/relatorios/:numero/dados","description":"

Para detalhes de um relatório específico use o endpoint /relatorios/{numero}/dados, onde o retorno inclui todos as informações obtidas pelas validações de cada Matriz.

Todas as possibilidades de retorno estão listadas abaixo em suas respectivas chaves com tabelas de detalhes. Sua Matriz pode não retornar todas as chaves abaixo (consulte detalhes na Dashboard).

As chaves com valor null significam que a fonte não retornou o dado em questão ou que o dado não é pertinentente à consulta (ex.: A infração pode ser identificada pelo AIT ou pelo NIT, dependendo da fonte, então as duas não aparecerão juntas).

Parâmetros de entrada

Para esta requisição, envie o Token no Header como Authorization e o número do protocolo na própria URL:

/relatorios/99988855-0000-aaaa-abcd-123456789012/dados\n

Exemplo de retorno de sucesso

{\n  \"status_code\": 200,\n  \"result\": {\n    \"atualizado_em\": \"2017-03-08T14:35:30.416Z\",\n    \"mensagem\": \"Obteve um total de 40 pontos na validação.\",\n    \"nome\": \"consultaPessoaDefault\",\n    \"numero\": \"99988855-0000-aaaa-abcd-123456789012\",\n    \"resultado\": \"40\",\n    \"status\": \"processando\",\n    \"cpf\": {\n      // Consulte a tabela de CPF abaixo para mais detalhes\n    },\n    \"veiculo\": {\n      // Consulte a tabela de Veículo abaixo para mais detalhes\n    },\n    \"cnh\": {\n      // Consulte a tabela de CNH abaixo para mais detalhes\n    },\n    \"cnpj\": {\n      // Consulte a tabela de CNPJ abaixo para mais detalhes\n    },\n    \"divida_ativa\": {\n      // Consulte a tabela de Dívida Ativa abaixo para mais detalhes\n    },\n    \"infracoes\": {\n      \"itens\": [\n        // Consulte a tabela de Infrações abaixo para mais detalhes\n      ]\n    },\n    \"protestos\": {\n      // Consulte a tabela de Protestos abaixo para mais detalhes\n    },\n    \"processos\": {\n      \"itens\": [\n        // Consulte a tabela de Processos abaixo para mais detalhes\n      ]\n    },\n    \"jucesp\": {\n      \"itens\": [\n        // Consulte a tabela de JUCESP abaixo para mais detalhes\n      ]\n    },\n    \"siafi\": {\n      \"itens\": [\n        // Consulte a tabela de SIAFI abaixo para mais detalhes\n      ]\n    },\n    \"blacklist\": {\n      \"ceis\": {\n        \"itens\": [\n          // Consulte a tabela de CEIS abaixo para mais detalhes\n        ]\n      },\n      \"cadicon\": {\n        \"itens\": [\n          // Consulte a tabela de CADICON abaixo para mais detalhes\n        ]\n      },\n      \"cadirreg\": {\n        \"itens\": [\n          // Consulte a tabela de CADIRREG abaixo para mais detalhes\n        ]\n      },\n      \"cepim\": {\n        \"itens\": [\n          // Consulte a tabela de CEPIM abaixo para mais detalhes\n        ]\n      },\n      \"cnep\": {\n        \"itens\": [\n          // Consulte a tabela de CNEP abaixo para mais detalhes\n        ]\n      },\n    },\n    \"certidoes_negativas\": {\n      \"itens\": [\n        // Consulte a tabela de Certidões Negativas abaixo para mais detalhes\n      ]\n    }\n    \n  }\n}\n

Exemplo de retorno de erro

{\n    \"error\": \"Not Found\",\n    \"message\": \"Protocolo não encontrado.\",\n    \"status_code\": 404\n}\n

Tabela de retorno CPF

Retornos possíveis na chave result.cpf em formato de Objeto.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
numero	Número do CPF	\"111.222.333-88\"
nome	Nome da pessoa	\"Luis Silva\"
data_de_nascimento	Data de Nascimento	\"19/04/1992\"
cpf_situacao_cadastral	Situação cadastral na Receita	\"REGULAR\"
cpf_data_de_inscricao	Data de inscrição	\"22/04/1995\"
cpf_digito_verificador	Dígito verificador do CPF	\"00\"
cpf_anterior_1990	CPF anterior à 1990	\"N\"
ano_obito	Ano de óbito	\"2011\"

Tabela de retorno Veículo

Retornos possíveis na chave result.veiculo em formato de Objeto.

Campo	Descrição	Exemplo
placa	Placa do veículo	\"IDW0011\"
renavam	Número do Renavam	\"1079993743\"
documento_proprietario	CPF do proprietário	\"081.344.499-42\"
nome_proprietario	Nome do proprietário	\"HUGO LUIS DE OLIVEIRA\"
tipo	Tipo do veículo	\"AUTOMOVEL\"
especie	Espécie do veículo	\"PASSAGEIRO\"
carroceria	Carroceria	\"NÃO APLICAVEL\"
categoria	Categoria do veículo	\"PARTICULAR\"
combustivel	Combustível	\"ALCOOL/GASOLINA \"
marca	Marca	\"GM\"
modelo	Modelo	\"ZAFIRA CD\"
ano_fabricacao	Ano de fabricação	\"2015\"
ano_modelo	Ano do modelo	\"2016\"
cor	Cor do veículo	\"PRATA\"
lotacao	Capacidade máxima de pessoas	\"5\"
capacidade_carga	Capacidade em Toneladas	\"0,70\"
potencia	Potência do veículo	\"155\"
cilindradas	Número de cilindradas	\"1400\"

Tabela de retorno CNH

Retornos possíveis na chave result.cnh em formato de Objeto.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
categoria	Categoria da CNH	\"B\"
data_emissao	Data de emissão	\"26/08/2014\"
data_validade	Data de vencimento da CNH	\"18/08/2019\"
nome	Nome completo	\"RAFAEL DOS SANTOS\"
nome_mae	Nome da mãe	\"MARINA DOS SANTOS\"
numero	Número da CNH	\"0935355567\"
numero_registro	Número do registro	\"00869189293\"
numero_seguranca	Número de segurança do documento	\"14199673687\"

Tabela de retorno CNPJ

Retornos possíveis na chave result.cnpj em formato de Objeto.

Campo	Descrição	Exemplo
atividade_principal	Ramo de atividade da empresa	\"64.21-2-00 - Bancos comerciais\"
capital_social	Capital Social em Reais	26151371.68
data_abertura	Data de abertura	\"20/10/1994\"
data_situacao_cadastral	Data da Situação Cadastral	\"03/11/2005\"
data_situacao_especial	Data da Situação Especial	\"03/11/2010\"
email	Email da empresa	\"teste@example.com\"
ente_federativo_responsavel	Ente Federativo Responsável	\"SP\"
motivo_situacao_cadastral	Motivo da situação cadastral	\"INCORPORACAO\"
natureza_juridica	Natureza Jurídica	\"206-2 - Sociedade Empresária Limitada\"
nome_empresarial	Razão Social	\"EMPRESA TECH DE TECNOLOGIA LTDA - ME\"
nome_fantasia	Nome fantasia	\"HIGH TECH\"
numero	Número do CNPJ	\"35012399000140\"
situacao_cadastral	Situação Cadastral	\"ATIVA\"
situacao_especial	Situação especial	\"RECUPERACAO JUDICIAL\"
telefone	Telefone	\"(31) 3411-1132\"
tipo	Tipo de empresa	\"MATRIZ\"
`atividades_secundarias`	Lista contendo as atividades secundárias da Empresa (se disponível)	\"62.09-1-00 - Suporte técnico, manutenção e outros serviços em tecnologia da informação\"
`localizacao.bairro`	Bairro	\"LUXEMBURGO\"
`localizacao.cep`	CEP	\"34560000\"
`localizacao.cidade`	Cidade	\"BELO HORIZONTE\"
`localizacao.logradouro`	Logradouro	\"AV RAJA GABAGLIA\"
`qsa[].nome`	Nome	\"João da Silva\"
`qsa[].nome_representante_legal`	Nome do representante legal	\"Márcia Ribeiro\"
`qsa[].pais_origem`	País de origem	\"Estados Unidos\"
`qsa[].qualificacao`	Qualificação	\"17-Procurador\"
`qsa[].qualificacao_representante_legal`	Qualificação do representante legal	\"17-Procurador\"

Tabela de retorno Dívida Ativa

Retornos possíveis na chave result.divida_ativa em formato de Objeto.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
error	Código de erro	\"INPUT_ERROR\"
mensagem_erro	Mensagem do erro	\"Dados de entrada inválidos.\"
nome	Nome devedor	\"INTERS TECH LTDA - ME\"
valor_devido	Valor devido em Reais	\"25.887,02\"

Tabela de retorno Infrações

Retornos possíveis na chave result.infracoes.itens em formato de Lista de objetos.

Campo	Descrição	Exemplo
agente_emissor	Agente emissor	\"SMTR-MULTA MUNICIPIO\"
ait	Auto de infração de trânsito	\"B66487112\"
amparo_legal	Amparto Legal	\"ART 184 INC III\"
data_notificacao	Data da notificação	\"29/11/2016\"
data_vencimento	Data de vencimento	\"23/01/2017\"
codigo	Código de indentificação	\"65992\"
descricao	Descrição da infração	\"CONDUZIR O VEICULO REGISTRADO QUE NAO ESTEJA DEVIDAMENTE LICENCIADO\"
emitido_em	Data de emissão	\"21/10/2016\"
fonte	Fonte da infração	\"PontosDetranRJService\"
gravidade	Nível de gravidade	\"GRAVÍSSIMA\"
local	Local da infração	\"ESTRADA DA BARRA DA TIJUCA 50 RIO DE JANEIRO\"
nit	Notificação de Infração de Trânsito	\"66892203\"
orgao_autuador	Orgão que autuou a infração	\"DETRAN\"
orgao_emissor	Orgão de emissão da infração	\"P.M RIO DE JANEIRO\"
placa	Placa do veículo	\"MAT2221\"
pontos	Pontos retidos na carteira de motorista	\"4\"
processo	Número do processo associado à infração	\"8371733\"
protocolo	Número do protocolo associado à infração	\"90a0.acd0.ce69.d3b4.\"
renainf	RENAINF	\"V012935567\"
responsavel_pontos	Nome do responsável pelos pontos	\"RODRIGO NOGUEIRA DE LIMA\"
status_de_pagamento	Status do pagamento	\"PENALIDADE - NÃO PAGA TRANSITADO EM JULGADO\"
uf	UF da infração	\"SP\"
valor_original	Valor original da infração	\"130,16\"
valor_pago	Valor pago	\"130,16\"

Tabela de retorno Protestos

Retornos possíveis na chave result.protestos em formato Objeto.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
estados_indeterminados	Estados onde não foi possível determinar protestos	[\"MT\", \"AM\"]
estados_com_protestos	Estados onde constam protestos	[\"RJ\", \"PR\", \"RO\"]
estados_sem_protestos	Estados onde não constam protestos	[\"SP\", \"RS\", \"GO\"]

Tabela de retorno Processos

Retornos possíveis na chave result.processos.itens em formato de Lista de objetos.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
acao	Ação do processo	\"Cível Execução de Título Extrajudicial->Processo de Execução->PROCESSO CÍVEL E DO TRABALHO\"
`arquivamento.caixa`	Caixa de arquivamento	\"20113461188\"
`arquivamento.estante`	Estante	\"19\"
`arquivamento.livro`	Livro do arquivamento	\"Feitos Cíveis\"
`arquivamento.local`	Local	\"AUTOS RETORNADOS AO CARTÓRIO\"
`arquivamento.localizador`	Localizador	\"11222A14HA\"
`arquivamento.maco`	Maço do arquivamento	\"6451\"
`arquivamento.prateleira`	Prateleira de arquivamento	\"M\"
assistencia	Assistência	\"Paga\"
assunto	Assunto do processo	\"Dano Moral\"
classe	Classe do processo	\"Procedimento Comum\"
data_de_ajuizamento	Data de ajuizamento	\"10/11/2011\"
data_de_distribuicao	Data de distrubuição	\"16/05/2012 16:38\"
data_de_julgamento	Data de julgamento	\"21/01/2014\"
data_de_recebimento	Data de recebimento	\"22/03/2017\"
fonte	Fonte do processo	\"ProcessosTJSP\"
`identificacao.ano`	Ano de identificação	\"122/2011\"
`identificacao.controle`	Controle	\"99AUK18A\"
`identificacao.guia_inicial`	Guia inicial	\"201213302805\"
`identificacao.numero`	Número de identificação	\"0000167-59.2014.8.25.0000\"
impedimento	Impedimento	\"NÃO\"
instancia	Instância do processo	\"2\"
juiz	Nome do juiz	\"Márcia Alves de Mello\"
`localizacao.bairro`	Bairro	\"CASA VERDE\"
`localizacao.cep`	CEP	\"02514000\"
`localizacao.cidade`	Cidade	\"SAO PAULO\"
`localizacao.comarca`	Comarca	\"ANAPOLIS -6A VARA CIVEL\"
`localizacao.complemento`	Complemento	\"APT 609\"
`localizacao.endereco`	Endereço	\"Av. Erasmo Braga 155 Salas 310B,312Be314B \"
`localizacao.estado`	Estado	\"SP\"
`localizacao.foro`	Foro	\"1ª Vara do Juizado Especial Cível - Foro de Guarulhos\"
`localizacao.logradouro`	Logradouro	\"R DAS AVES\"
`localizacao.lotacao`	Lotação	\"Segunda Vara\"
`localizacao.municipio`	Município	\"SAO PAULO\"
`localizacao.numero`	Número	\"677\"
`localizacao.oficio`	Ofício	\"3º Ofício de Registro de Distribuição\"
`localizacao.vara`	Vara	\"8º Juizado Especial Cível\"
natureza	Natureza do processo	\"Cível Comum\"
numero	Número do processo	\"0001951-64.1996.8.18.0140\"
observacoes	Observações	\"\"
`partes[].cnpj`	CNPJ da parte	\"21.665.555/0001-02\"
`partes[].cpf`	CPF da parte	\"111.111.222-99\"
`partes[].data_de_nascimento`	Data de nascimento	\"11/08/1985\"
`partes[].nome`	Nome da parte	\"AUTOMOVEIS COMERCIO LTDA\"
`partes[].rg`	RG	\"126291/RR\"
`partes[].sexo`	Sexo	\"Masculino\"
`partes[].tipo`	Tipo	\"Pessoa\"
`partes[].titulo`	Título	\"Exectdo\"
peticao_inicial	Número da petição inicial	\"201200568578\"
segredo	Segredo	\"NÃO\"
sigiloso	Processo é sigiloso	\"NÃO\"
situacao	Situação do processo	\"Arquivado - Guia remetida a VEP\"
tramitacao_preferencial	Tramitação preferencial	\"Não\"
url	URL para consulta do processo	\"http://www.tjrs.jus.br/site_php/consulta/consulta_processo.php?PARAMETROS\"
valor	Valor do processo	\"$15,200.00\"

Tabela de retorno JUCESP

Retornos possíveis na chave result.jucesp.itens em formato de Lista de objetos.

Campo	Descrição	Exemplo
arquivamento	Arquivamento JUCESP	\"\"
capital	Capital	\"R$ 862.000,00 (Oitocentos E Sessenta E Dois Mil Reais)\"
cnpj	CNPJ	\"42.331.652/0001-92\"
data_constituicao	Data de constituição	\"14/07/2016\"
data_emissao	Data de emissão	\"05/04/2017 19:06:21\"
data_inicio_atividade	Data de início de atividade	\"01/07/2016\"
dissolvida	Dissolvida	false
empresa	Razão social da empresa	\"FAAST SERVICOS TECH LTDA\"
erro_codigo	Código do erro, caso exista	\"INVALID_DATA_ERROR\"
erro_mensagem	Mensagem do erro	\"Não foi encontrada nenhuma empresa.\"
`localizacao.cep`	CEP	\"02331-100\"
`localizacao.logradouro`	Logradouro	\"Avenida Paulista NUMERO: 807\"
`localizacao.municipio`	Município	\"Sao Paulo\"
`localizacao.uf`	UF	\"SP\"
nire	Número de Identificação do Registro de Empresas	\"SP982134158\"
objeto_social	Objeto Social	\"Portais, provedores de conteúdo e outros serviços de informação na internet\"
`socios[].cpf`	CPF dos sócios	\"331.221.554-04\"
`socios[].endereco.bairro`	Bairro	\"BELA VISTA\"
`socios[].endereco.cep`	CEP	\"00921-91\"
`socios[].endereco.complemento`	Complemento	\"\"
`socios[].endereco.logradouro`	Logradouro	\"AV PAULISTA\"
`socios[].endereco.municipio`	Munícipio	\"SÃO PAULO\"
`socios[].endereco.numero`	Número do endereço	\"991\"
`socios[].nacionalidade`	Nacionalidade	\"BRASILEIRA\"
`socios[].nire`	Número de Identificação de Registro de Empresas	\"SP982134158\"
`socios[].nome`	Nome do sócio	\"PAULO SILVA\"
`socios[].participacao`	Participação em reais	\"99782,99\"
`socios[].rg`	RG	\"499292911\"
`socios[].situacao`	Situação do sócio	\"ATIVO\"
url	URL	\"https://www.jucesponline.sp.gov.br/VisualizaTicket.aspx?sc=NUMERO\"

Tabela de retorno SIAFI

Retornos possíveis na chave result.siafi.itens em formato de Lista de objetos.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
atendimento	Atendimento	\"Comprovado\"
fonte_informacao	Fonte da informação	\"SICONV\"
requisito_fiscal	Requisito Fiscal	\"Regularidade quanto à Prestação de Contas de Recursos Federais recebidos anteriormente\"
validade	Validade	\"26/04/2017\"

Tabela de retorno CEIS

Retornos possíveis na chave result.blacklists.ceis.itens em formato de Lista de objetos.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
abrangencia_decisao_judicial	Abrangência da decisão judicial	\"\"
cpf_cnpj	Número do CPF ou CNPJ	\"20676287000112\"
data_final_sancao	Data final da sanção	\"09/07/2017\"
data_inicio_sancao	Data de início da sanção	\"10/04/2017\"
data_origem_informacoes	Data da origem das informações	\"10/04/2017\"
data_publicacao	Data de publicação	\"10/04/2017\"
detalhamento	Detalhamento	\"\"
nome_fantasia	Nome fantasia	\"GIG BATTERIES\"
nome_informado_pelo_orgao	Nome informado pelo órgão	\"GIG BATTERIES ASA NORTE LTDA-ME\"
numero_processo	Número do processo	\"098.001.654/2015\"
orgao_sancionador	Órgão sancionador	\"POLÍCIA CIVIL DO DISTRITO FEDERAL\"
origem_informacoes	Origem das informações	\"Governo do Distrito Federal\"
publicacao	Publicação	\"Diário Oficial do Estado Seção 3 Pagina 55\"
razao_social	Razão social	\"GIG BATTERIES ASA NORTE LTDA-ME\"
tipo_pessoa	Tipo de pessoa	\"Juridica\"
tipo_sancao	Tipo da sanção	\"Suspensão - Legislação Estadual\"
uf_orgao_sancionador	UF do órgão sancionador	\"DF\"

Tabela de retorno CADICON

Retornos possíveis na chave result.blacklists.cadicon.itens em formato de Lista de objetos.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
acordao	Acordão	\"1231/2013 - Plenário\"
atualizacao	Atualização	\"08/04/2017\"
cpf	CPF	\"067.561.871-91\"
data_transito	Data de trânsito	\"16/08/2011\"
processo	Processo	\"21787/2009-6\"
responsavel	Nome do responsável	\"LUCAS GUIMARÃES FERREIRA NETO\"
tribunal	Tribunal	\"TCU\"
valor_debito	Valor do débito	\"Não informado\"
valor_multa	Valor da multa	\"R$14.511,00\"

Tabela de retorno CADIRREG

Retornos possíveis na chave result.blacklists.cadirreg.itens em formato de Lista de objetos.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
apos_lei_complementar	Após lei complementar	\"\"
funcao	Função	\"ENTIDADE BENEFICIADA\"
julgamento	Julgamento	\"IrDbMt\"
nome	Nome	\"101 EMPRESA TECH LTDA\"
orgao	Órgão	\"101 EMPRESA TECH LTDA (BENEFICIÁRIO); MINISTÉRIO DO ESPORTE (TRANSFERIDOR)\"
origem_recursos	Origem dos recursos	\"TCE - Acordo ou Convênio\"
processo	Identificação do processo	\"39812/2015-8\"
url	URL	\"https://contas.tcu.gov.br/cadirreg/CadirregDetalhePessoa?cod=COF&dt=Tue%20Apr%2011%2009:48:21%20BRT%202017\"

Tabela de retorno CEPIM

Retornos possíveis na chave result.blacklists.cepim.itens em formato de Lista de objetos.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
cnpj	CNPJ	\"04.092.416/0001-38\"
motivo	Motivo por constar no CEPIM	\"IRREGULARIDADES NA PRESTAÇÃO DE CONTAS (ATRASO, OMISSÃO OU IMPUGNAÇÃO)\"
razao_social	Razão social	\"101 EMPRESA TECH LTDA\"

Tabela de retorno CNEP

Retornos possíveis na chave result.blacklists.cnep.itens em formato de Lista de objetos.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
cpf_cnpj	Número do CPF ou CNPJ	\"20676287000112\"
data_final_sancao	Data final da sanção	\"09/07/2017\"
data_inicio_sancao	Data de início da sanção	\"10/04/2017\"
data_origem_informacoes	Data da origem das informações	\"10/04/2017\"
data_publicacao	Data de publicação	\"10/04/2017\"
detalhamento	Detalhamento	\"\"
nome_fantasia	Nome fantasia	\"GIG BATTERIES\"
nome_informado_pelo_orgao	Nome informado pelo órgão	\"GIG BATTERIES ASA NORTE LTDA-ME\"
numero_processo	Número do processo	\"098.001.654/2015\"
orgao_sancionador	Órgão sancionador	\"POLÍCIA CIVIL DO DISTRITO FEDERAL\"
origem_informacoes	Origem das informações	\"Governo do Distrito Federal\"
publicacao	Publicação	\"Diário Oficial do Estado Seção 3 Pagina 55\"
razao_social	Razão social	\"GIG BATTERIES ASA NORTE LTDA-ME\"
tipo_pessoa	Tipo de pessoa	\"Jurídica\"
tipo_sancao	Tipo da sanção	\"Suspensão - Legislação Estadual\"
uf_orgao_sancionador	UF do órgão responsável pela sanção	\"SP\"
valor_multa	Valor da multa	\"R$52.812,00\"

Tabela de retorno Certidões Negativas

Retornos possíveis na chave result.certidoes_negativas.itens em formato de Lista de objetos.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
criado_em	Criado em	\"2017-04-26T21:40:03.300Z\"
fonte	Fonte	\"TRTSP\"
nada_consta	Nada consta	true
protocolo	Protocolo	\"128719836/2017\"

","urlObject":{"protocol":"https","path":["relatorios",":numero","dados"],"host":["api-v2","idwall","co"],"query":[],"variable":[{"id":"numero","type":"any","value":"00000000-0000-0000-0000-000000000000","key":"numero"},{"type":"any","value":"0"},{"type":"any","value":"0","key":1},{"type":"any","value":"0","key":2},{"type":"any","value":"0","key":3},{"type":"any","value":"0","key":4},{"type":"any","value":"0","key":5},{"type":"any","value":"0","key":6},{"type":"any","value":"0","key":7},{"type":"any","value":"-","key":8},{"type":"any","value":"0","key":9},{"type":"any","value":"0","key":10},{"type":"any","value":"0","key":11},{"type":"any","value":"0","key":12},{"type":"any","value":"-","key":13},{"type":"any","value":"0","key":14},{"type":"any","value":"0","key":15},{"type":"any","value":"0","key":16},{"type":"any","value":"0","key":17},{"type":"any","value":"-","key":18},{"type":"any","value":"0","key":19},{"type":"any","value":"0","key":20},{"type":"any","value":"0","key":21},{"type":"any","value":"0","key":22},{"type":"any","value":"-","key":23},{"type":"any","value":"0","key":24},{"type":"any","value":"0","key":25},{"type":"any","value":"0","key":26},{"type":"any","value":"0","key":27},{"type":"any","value":"0","key":28},{"type":"any","value":"0","key":29},{"type":"any","value":"0","key":30},{"type":"any","value":"0","key":31},{"type":"any","value":"0","key":32},{"type":"any","value":"0","key":33},{"type":"any","value":"0","key":34},{"type":"any","value":"0","key":35}]}},"response":[],"_postman_id":"93067a8c-5193-4025-91e5-62d81de4e99a"},{"name":"Relatório parâmetros","id":"1726a7b8-2813-4f79-9492-3e052ebf153a","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/relatorios/:numero/parametros","description":"

Com o endpoint de /relatorios/{numero}/parametros você pode consultar todos os parâmetros que serão usados para as consultas posteriores de determinado protocolo na plataforma.

Parâmetros de entrada

Para esta requisição, envie o Token no Header como Authorization e o número do protocolo na própria URL:

/relatorios/99988855-0000-aaaa-abcd-123456789012/parametros\n

Abaixo, a tabela com parâmetros aceitos pela API da IDwall e suas respectivas configurações.

Leve em consideração:

Todas as palavras serão convertidas para UPPERCASE;
Espaços no começo e final dos parâmetros serão removidos;
Espaços múltiplos serão substituídos por um espaço;

Parâmetro	Nome	Descrição	Tipo	Instruções
cnh_imagem_frente	Imagem frontal da CNH	Imagem em formato de Data URI Base64 com a parte frontal da CNH	string
cnh_imagem_verso	Imagem do verso da CNH	Imagem em formato de Data URI Base64 com o verso da CNH	string
cnh_numero	CNH	Número da CNH	string	Pontos e hífens serão removidos; Deve ter exatamente 11 dígitos; Somente números são aceitos;
cnh_numero_seguranca	Número de segurança CNH	Número de segurança da CNH	string
cnpj_nome	Razão social	Razão Social da empresa	string
cnpj_numero	CNPJ	Número do CNPJ	string	Pontos e hífens serão removidos; Deve ter exatamente 14 dígitos; Somente números são aceitos; Deve ser um CNPJ válido;
cpf_data_de_nascimento	Data de nascimento	Data de nascimento	string	Data deve estar válida no formato dd/mm/aaaa; Deve ser menor ou igual a data de hoje;
cpf_estado_civil	Estado civil	Estado civil	string	Aceita: SOLTEIRO, CASADO, DIVORCIADO, VIÚVO, SEPARADO;
cpf_nome	Nome completo	Nome completo da pessoa a ser consultada	string
cpf_nome_da_mae	Nome da mãe	Nome completo da mãe	string
cpf_nome_do_pai	Nome do pai	Nome completo do pai	string
cpf_numero	CPF	Número do CPF sem pontos e traços	string	Pontos e hífens serão removidos; Deve ter exatamente 11 dígitos; Somente números são aceitos; Deve ser um CPF válido;
cpf_sexo	Sexo	Sexo	string
endereco_bairro	Bairro	Bairro do endereço	string
endereco_cep	CEP	CEP do endereço	string	Pontos e hífens serão removidos; Deve ter exatamente 8 dígitos;
endereco_cidade	Cidade	Cidade	string
endereco_complemento	Complemento	Andar, sala comercial, etc	string
endereco_estado	Estado	Estado por extenso	string	Aceita: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO
endereco_logradouro	Logradouro	Rua, Avenida, etc	string
endereco_numero	Número do endereço	Número da casa/apartamento	string
rg_data_de_expedicao	Data de expedição	Data de expedição do RG	string	Data deve estar válida no formato dd/mm/aaaa; Deve ser menor ou igual a data de hoje;
rg_digito	Dígito RG	Dígito do RG	string	Pontos e hífens serão removidos; Deve ter no máximo 2 dígitos;
rg_estado_expedicao	Estao expedição	Estado de expedição do RG	string	Aceita: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO
rg_imagem_frente	Imagem frontal do RG	Imagem em formato de Data URI Base64 com a parte frontal do RG	string
rg_imagem_verso	Imagem do verso do RG	Imagem em formato de Data URI Base64 com o verso do RG	string
rg_numero	RG	Número do RG	string	Pontos e hífens serão removidos; Deve ter no mínimo 5 e no máximo 15 dígitos;
rg_orgao_emissor	Órgão emissor	Orgão emissor do RG	string
veiculo_placa	Placa	Placa do veículo	string	Pontos e hífens serão removidos; Deve ter exatamente 7 dígitos; Deve estar no formato AAA9999;
veiculo_renavam	Renavam	Número do RENAVAM	string	Pontos e hífens serão removidos; Deve ter no minímo 9 e no máximo 11 dígitos;
estados_consultados	Estados consultados	Estados a serem consultados	Lista(string)	Aceita na Lista: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO

Exemplo de retorno de sucesso

{\n    \"status_code\": 200,\n    \"result\": {\n        \"atualizado_em\": \"2017-03-08T14:35:30.416Z\",\n        \"mensagem\": \"\",\n        \"nome\": \"consultaPessoaDefault\",\n        \"numero\": \"99988855-0000-aaaa-abcd-123456789012\",\n        \"resultado\": \"40\",\n        \"status\": \"processando\",\n        \"parametros\": {\n            \"cpf\": \"12334555599\",\n            \"cnh\": \"1112224444\",\n            \"data_de_expedicao_rg\": \"21/10/2010\",\n            \"data_de_nascimento\": \"05/12/1995\",\n            \"digito_rg\": \"x\",\n            \"endereco\": \"Avenida Loop Infinito\",\n            \"estado\": \"SP\",\n            \"estado_expedicao_rg\": \"SP\",\n            \"nome\": \"Lucas Ribeiro\",\n            \"nome_da_mae\": \"Paula Álvares\",\n            \"nome_do_pai\": \"Antonio Santos\",\n            \"numero_do_endereco\": \"0\",\n            \"sexo\": \"M\"\n        }\n    }\n}\n

Caso o protocolo tenha sido criado através de um envio de imagem (RG ou CNH) para extração de dados por meio de OCR, a chave documento_ocr estará presente no retorno, confome padrão abaixo:

{\n    \"status_code\": 200,\n    \"result\": {\n        \"atualizado_em\": \"2017-03-08T14:35:30.416Z\",\n        \"mensagem\": \"\",\n        \"nome\": \"consultaPessoaImagemDefault\",\n        \"numero\": \"99988855-0000-aaaa-abcd-123456789012\",\n        \"resultado\": \"40\",\n        \"status\": \"processando\",\n        \"parametros\": { },\n        \"documento_ocr\": {\n            \"filename_front\": \"URL_DO_ARQUIVO\",\n            \"filename_full\": \"URL_DO_ARQUIVO\",\n            \"atualizado_em\": \"2017-05-11 14:33:29\",\n            \"criado_em\": \"2017-05-11 14:31:04\",\n            \"status\": \"PENDENTE\",\n            \"nome\": \"VITOR DOS SANTOS\",\n            \"rg\": \"17372991\",\n            \"orgao_emissor_rg\": \"SSP\",\n            \"estado_emissao_rg\": \"SP\",\n            \"cpf\": \"49518723188\",\n            \"data_de_nascimento\": \"05/12/1995\",\n            \"nome_do_pai\": \"LUCAS DOS SANTOS\",\n            \"nome_da_mae\": \"MARIA OLIVEIRA DOS SANTOS\",\n            \"categoria\": \"B\",\n            \"numero_registro\": \"06091347151\",\n            \"validade\": \"11/12/2018\",\n            \"data_primeira_habilitacao\": \"18/06/2014\",\n            \"observacoes\": \"EXERCE ATIVIDADE REMUNERADA\",\n            \"data_de_emissao\": \"23/06/2015\",\n            \"numero_renach\": \"RJ729136156\",\n            \"numero_espelho\": \"2225919955\",\n            \"permissao\": \"\",\n            \"orgao_emissor\": \"\",\n            \"local_emissao\": \"UBERLANDIA\",\n            \"estado_emissao\": \"MG\",\n            \"acc\": \"\",\n            \"numero\": \"\",\n            \"numero_seguranca\": \"10163918031\",\n            \"filename_back\": \"URL_DO_ARQUIVO\"\n        }\n    }\n}\n

Exemplo de retorno de erro

{\n    \"error\": \"Not Found\",\n    \"message\": \"Protocolo não encontrado.\",\n    \"status_code\": 404\n}\n

\n","urlObject":{"protocol":"https","path":["relatorios",":numero","parametros"],"host":["api-v2","idwall","co"],"query":[],"variable":[{"id":"numero","type":"any","value":"00000000-0000-0000-0000-000000000000","key":"numero"},{"type":"any","value":"0"},{"type":"any","value":"0","key":1},{"type":"any","value":"0","key":2},{"type":"any","value":"0","key":3},{"type":"any","value":"0","key":4},{"type":"any","value":"0","key":5},{"type":"any","value":"0","key":6},{"type":"any","value":"0","key":7},{"type":"any","value":"-","key":8},{"type":"any","value":"0","key":9},{"type":"any","value":"0","key":10},{"type":"any","value":"0","key":11},{"type":"any","value":"0","key":12},{"type":"any","value":"-","key":13},{"type":"any","value":"0","key":14},{"type":"any","value":"0","key":15},{"type":"any","value":"0","key":16},{"type":"any","value":"0","key":17},{"type":"any","value":"-","key":18},{"type":"any","value":"0","key":19},{"type":"any","value":"0","key":20},{"type":"any","value":"0","key":21},{"type":"any","value":"0","key":22},{"type":"any","value":"-","key":23},{"type":"any","value":"0","key":24},{"type":"any","value":"0","key":25},{"type":"any","value":"0","key":26},{"type":"any","value":"0","key":27},{"type":"any","value":"0","key":28},{"type":"any","value":"0","key":29},{"type":"any","value":"0","key":30},{"type":"any","value":"0","key":31},{"type":"any","value":"0","key":32},{"type":"any","value":"0","key":33},{"type":"any","value":"0","key":34},{"type":"any","value":"0","key":35}]}},"response":[],"_postman_id":"1726a7b8-2813-4f79-9492-3e052ebf153a"},{"name":"Relatórios validações","id":"fcf632d3-1f76-41ae-8283-f2390e70e99d","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/relatorios/:numero/validacoes","description":"

No endpoint de /relatorios/{numero}/validacoes serão retornadas todas as validações que foram realizadas de acordo com a matriz referente ao protocolo.

Parâmetros de entrada

Para esta requisição, envie o Token no Header como Authorization e o número do protocolo na própria URL:

/relatorios/99988855-0000-aaaa-abcd-123456789012/validacoes\n

Exemplo de retorno de sucesso

{\n    \"status_code\": 200,\n    \"result\": {\n        \"atualizado_em\": \"2017-03-08T14:35:30.416Z\",\n        \"mensagem\": \"Obteve um total de 40 pontos na validação.\",\n        \"nome\": \"consultaPessoaDefault\",\n        \"numero\": \"99988855-0000-aaaa-abcd-123456789012\",\n        \"resultado\": \"40\",\n        \"status\": \"processando\",\n        \"validacoes\": [\n            {\n                \"regra\": \"maisDe21Anos\",\n                \"resultado\": \"0\"\n            },\n            {\n                \"regra\": \"categoria_cnh\",\n                \"resultado\": \"0\"\n            },\n            {\n                \"regra\": \"situacaoCPF_nascimento\",\n                \"resultado\": \"0\"\n            },\n            {\n                \"regra\": \"situacaoCPF_nome\",\n                \"resultado\": \"0\"\n            },\n            {\n                \"regra\": \"situacaoCPF_obito\",\n                \"resultado\": \"0\"\n            },\n            {\n                \"regra\": \"cpf_valid\",\n                \"resultado\": \"0\"\n            }\n        ]\n    }\n}\n

Exemplo de retorno de erro

{\n    \"error\": \"Not Found\",\n    \"message\": \"Protocolo não encontrado.\",\n    \"status_code\": 404\n}\n

\n","urlObject":{"protocol":"https","path":["relatorios",":numero","validacoes"],"host":["api-v2","idwall","co"],"query":[],"variable":[{"id":"numero","type":"any","value":"00000000-0000-0000-0000-000000000000","key":"numero"},{"type":"any","value":"0"},{"type":"any","value":"0","key":1},{"type":"any","value":"0","key":2},{"type":"any","value":"0","key":3},{"type":"any","value":"0","key":4},{"type":"any","value":"0","key":5},{"type":"any","value":"0","key":6},{"type":"any","value":"0","key":7},{"type":"any","value":"-","key":8},{"type":"any","value":"0","key":9},{"type":"any","value":"0","key":10},{"type":"any","value":"0","key":11},{"type":"any","value":"0","key":12},{"type":"any","value":"-","key":13},{"type":"any","value":"0","key":14},{"type":"any","value":"0","key":15},{"type":"any","value":"0","key":16},{"type":"any","value":"0","key":17},{"type":"any","value":"-","key":18},{"type":"any","value":"0","key":19},{"type":"any","value":"0","key":20},{"type":"any","value":"0","key":21},{"type":"any","value":"0","key":22},{"type":"any","value":"-","key":23},{"type":"any","value":"0","key":24},{"type":"any","value":"0","key":25},{"type":"any","value":"0","key":26},{"type":"any","value":"0","key":27},{"type":"any","value":"0","key":28},{"type":"any","value":"0","key":29},{"type":"any","value":"0","key":30},{"type":"any","value":"0","key":31},{"type":"any","value":"0","key":32},{"type":"any","value":"0","key":33},{"type":"any","value":"0","key":34},{"type":"any","value":"0","key":35}]}},"response":[],"_postman_id":"fcf632d3-1f76-41ae-8283-f2390e70e99d"},{"name":"Consultas realizadas por relatório","id":"dc9967bc-7f97-4d4b-8731-44198c51e6a2","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/relatorios/:numero/consultas","description":"

Para verificar o status de todas as consultas feitas à fontes externas que já foram realizadas para determinado protocolo (e seus respectivos retornos), use o endpoint de /relatorios/{numero}/consultas.

Parâmetros de entrada

Para esta requisição, envie o Token no Header como Authorization e o número do protocolo na própria URL:

/relatorios/99988855-0000-aaaa-abcd-123456789012/consultas\n

Exemplo de tipos de erros

As consultas em cada fonte podem gerar alguns erros, segue uma descrição de todos os que já foram mapeados pelo nosso time:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Tipo do erro	Descrição
INTERNAL_ERROR	Ao realizar a consulta houve algum erro interno, estamos trabalhando para evitar que acontençam
INVALID_DATA_ERROR	Todos os parâmetros estão corretos, mas a fonte retornou um resultado inesperado. Ex.: Veículo não encontrado na base, CPF válido porém não consta na fonte
INPUT_ERROR	Algum campo enviado como parâmetro não está de acordo com o esperado. Ex.: CPF fora do padrão aceitável (exemplo, 33344357E5P); nome inválido (com dígitos dentro do nome - \"Maria123\"); sobrenome obrigatório não foi enviado; etc

Exemplo de retorno de sucesso

{\n  \"status_code\": 200,\n  \"result\": {\n    \"nome_matriz\": \"consultaEmpresaDefault\",\n    \"status_protocolo\": \"concluido\",\n    \"consultas\": [\n      {\n        \"nome\": \"RegularidadeFgtsCaixa\",\n        \"tentativas\": [\n          {\n            \"duracao_tentativa\": \"0\",\n            \"hora_fim_tentativa\": \"2017-03-08T09:58:38.712\",\n            \"hora_inicio_tentativa\": \"2017-03-08T09:58:38.531\",\n            \"msg_erro_tentativa\": null,\n            \"nome_fonte\": \"RegularidadeFgtsCaixa\",\n            \"status_fonte\": \"OK\",\n            \"status_tentativa\": \"SUCCESS\",\n            \"tipo_erro_tentativa\": null\n          }\n        ]\n      },\n      {\n        \"nome\": \"DividaAtivaFazenda\",\n        \"tentativas\": [\n          {\n            \"duracao_tentativa\": \"56\",\n            \"hora_fim_tentativa\": \"2017-03-08T09:58:50.352\",\n            \"hora_inicio_tentativa\": \"2017-03-08T09:57:54.185\",\n            \"msg_erro_tentativa\": null,\n            \"nome_fonte\": \"DividaAtivaFazenda\",\n            \"status_fonte\": \"OK\",\n            \"status_tentativa\": \"SUCCESS\",\n            \"tipo_erro_tentativa\": null\n          }\n        ]\n      },\n      {\n        \"nome\": \"PontosDetranRJService\",\n        \"tentativas\": [\n          {\n            \"duracao_tentativa\": \"102\",\n            \"hora_fim_tentativa\": \"2017-03-24T16:37:28.226\",\n            \"hora_inicio_tentativa\": \"2017-03-24T16:35:45.863\",\n            \"msg_erro_tentativa\": \"CNH Digitada não pertence ao CPF digitado.\",\n            \"nome_fonte\": \"DividaAtivaFazenda\",\n            \"status_fonte\": \"OK\",\n            \"status_tentativa\": \"FAIL\",\n            \"tipo_erro_tentativa\": \"INVALID_DATA_ERROR\"\n          }\n        ]\n      }\n    ]\n  }\n}\n

Exemplo de retorno de erro

{\n    \"error\": \"Not Found\",\n    \"message\": \"Protocolo não encontrado.\",\n    \"status_code\": 404\n}\n

\n","urlObject":{"protocol":"https","path":["relatorios",":numero","consultas"],"host":["api-v2","idwall","co"],"query":[],"variable":[{"id":"numero","type":"any","value":"00000000-0000-0000-0000-000000000000","key":"numero"},{"type":"any","value":"0"},{"type":"any","value":"0","key":1},{"type":"any","value":"0","key":2},{"type":"any","value":"0","key":3},{"type":"any","value":"0","key":4},{"type":"any","value":"0","key":5},{"type":"any","value":"0","key":6},{"type":"any","value":"0","key":7},{"type":"any","value":"-","key":8},{"type":"any","value":"0","key":9},{"type":"any","value":"0","key":10},{"type":"any","value":"0","key":11},{"type":"any","value":"0","key":12},{"type":"any","value":"-","key":13},{"type":"any","value":"0","key":14},{"type":"any","value":"0","key":15},{"type":"any","value":"0","key":16},{"type":"any","value":"0","key":17},{"type":"any","value":"-","key":18},{"type":"any","value":"0","key":19},{"type":"any","value":"0","key":20},{"type":"any","value":"0","key":21},{"type":"any","value":"0","key":22},{"type":"any","value":"-","key":23},{"type":"any","value":"0","key":24},{"type":"any","value":"0","key":25},{"type":"any","value":"0","key":26},{"type":"any","value":"0","key":27},{"type":"any","value":"0","key":28},{"type":"any","value":"0","key":29},{"type":"any","value":"0","key":30},{"type":"any","value":"0","key":31},{"type":"any","value":"0","key":32},{"type":"any","value":"0","key":33},{"type":"any","value":"0","key":34},{"type":"any","value":"0","key":35}]}},"response":[],"_postman_id":"dc9967bc-7f97-4d4b-8731-44198c51e6a2"},{"name":"Novo relatório","id":"da5662d4-ed16-4f6e-8a4c-ee6fa101af0a","request":{"method":"post","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n \"matriz\": \"string\",\n \"opcoes\": {\n \"estados_consultados\": [\n \"string\"\n ]\n },\n \"parametros\": {}\n}"},"url":"https://api-v2.idwall.co/relatorios","description":"

Para criar novos protocolos, faça o envio de um POST para o endpoint /relatorios com os parâmetros necessários no corpo da requisição.
Dessa forma, será criado um novo protocolo que seguirá para processamento e, posteriormente, consultado para verificação de novos status e resultados das fontes.

Parâmetros de entrada

Este endpoint possui 3 chaves principais, que devem ser enviadas com o Content-Type igual a application/json e Authorizatiion contendo o Token de usuário no Header.

A matriz que você deve enviar na requisição pode ser consultada no endpoint /matrizes, que retorna todas as que estão associadas ao seu usuário.\nAo checar a matriz, veja quais parâmetros podem ser enviados usando o endpoint /matrizes/:nomeMatriz.\nCaso seja necessário especifiar os estados do Brasil a serem consultados, use a chave opcoes.estados_consultados com as siglas dos estados (formato de array).

{\n    \"matriz\": \"string\", // Obrigatório\n    \"opcoes\": {\n        \"estados_consultados\": [\n            \"string\",\n            \"string\"\n        ]\n    },\n    \"parametros\": {\n        \"cpf_data_de_nascimento\": \"string\",\n        \"cpf_estado_civil\": \"string\",\n        \"cpf_nome\": \"string\",\n        \"cpf_nome_da_mae\": \"string\",\n        \"cpf_nome_do_pai\": \"string\"\n    }\n}\n

Exemplo de retorno de sucesso

{\n  \"status_code\": 200,\n  \"result\": {\n    \"numero\": \"99988855-0000-aaaa-abcd-123456789012\"\n  }\n}\n

Exemplo de retorno de erro

{\n  \"error\": \"Bad Request\",\n  \"message\": \"CPF e CNPJ presentes na mesma requisição.\",\n  \"status_code\": 400\n}\n

Em casos de envio de imagens

Caso suas matrizes de decisão estejam configuradas para fazer extração de texto à partir de imagens de documentos (OCR) o fluxo de processamento do protocolo será alterado.

Envio

Os parâmetros aceitos para imagens podem ser (nas extensões PNG, JPG ou JPEG):

Base64
URL

Dependendo do tipo de imagem configurada para sua matriz, os parâmetros poderão ser:

cnh_imagem_frente/cnh_imagem_verso/cnh_imagem_completa
rg_imagem_frente/rg_imagem_verso

Um exemplo de requisição POST ficaria da seguinte forma:

{\n    \"matriz\": \"string\",\n    \"parametros\": {\n        \"cnh_imagem_frente\": \"http://www.midiamax.com.br/sites/default/files/arquivos/noticias/2017/jan/cnh.jpg\",\n        \"cnh_imagem_verso\": \"http://www.midiamax.com.br/sites/default/files/arquivos/noticias/2017/jan/cnh.jpg\",\n    }\n}\n

Fluxo de validação

Assim que a requisição for enviada, as imagens serão baixadas em nosso servidor e em seguida passarão pela extração de texto, durante esse processo o status do Relatório será Pré-processando.

Quando o processamento for concluído o Relatório poderá seguir por dois caminhos:

O Relatório vai para o status Pendente e seguirá com as buscas nas nossas fontes.
Caso os dados não puderem ser extraídos (imagem quebrada, foto com qualidade baixa, etc) o relatório ficará com o status Ilegível, dessa forma deverá ser gerado um novo relatório com uma versão adequada da imagem.

Para consultar as informações extraídas das imagens e seus status, consulte a chave documento_ocr no endpoint /relatorios/{numero}/dados, descrito nesta mesma documentação.

\n","urlObject":{"protocol":"https","path":["relatorios"],"host":["api-v2","idwall","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"da5662d4-ed16-4f6e-8a4c-ee6fa101af0a"}],"id":"946c99ca-1e7e-42f6-98d9-30fc832a5825","description":"

Os relatórios são formados pelo conjunto de informações obtidas a partir de várias fontes e suas respectivas validações de acordo com alguma Matriz.

Eles podem ser do tipos:

Empresas (para consultas de Pessoa Jurídica)
Pessoas (para consultas de Pessoa Física)

Nos endpoints a seguir serão detalhados como enviar uma nova solicitação de Relatório, consultar listagens, status e dados agregados de cada um.

\n","_postman_id":"946c99ca-1e7e-42f6-98d9-30fc832a5825"},{"name":"Status","item":[{"name":"Status","id":"82a999b1-c5b2-41ee-8e95-dfa4a262720e","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/status","description":"

O endpoint de status é utilizado para verificar algumas informações de execução da API.

Você pode consultar alguns dados como:

Versão do servidor
Ambiente de execução
Referência da versão

Exemplo de retorno

{\n    \"versao\": \"2.0.3\",\n    \"ambiente\": \"production\",\n    \"ref\": \"45f2d31bd331fae5bc123d249da83b1\"\n}\n

\n","urlObject":{"protocol":"https","path":["status"],"host":["api-v2","idwall","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"82a999b1-c5b2-41ee-8e95-dfa4a262720e"},{"name":"Fontes","id":"b3b2d301-2eee-4a24-830a-d6799f7738ec","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/status/fontes","description":"

O endpoint de status é utilizado para verificar algumas informações de execução da API.

Você pode consultar alguns dados como:

Versão do servidor
Ambiente de execução
Referência da versão

Exemplo de retorno

{\n    \"versao\": \"2.0.3\",\n    \"ambiente\": \"production\",\n    \"ref\": \"45f2d31bd331fae5bc123d249da83b1\"\n}\n

\n","urlObject":{"protocol":"https","path":["status","fontes"],"host":["api-v2","idwall","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3b2d301-2eee-4a24-830a-d6799f7738ec"}],"id":"25b806d3-3c76-4e75-a4f2-2e45c72f324d","_postman_id":"25b806d3-3c76-4e75-a4f2-2e45c72f324d","description":""},{"name":"Usuários","item":[{"name":"Perfil do Usuário","id":"b79937bc-2bf1-4a02-b70a-c82eaede45c7","request":{"method":"get","header":[{"key":"Authorization","value":"{{token}}"}],"url":"https://api-v2.idwall.co/usuario","description":"

No endpoint de /usuario poderão ser consultadas as informações básicas do usuário relacionado ao Token que for enviado no Header.

Parâmetros de entrada

Neste endpoint apenas o Token é necessário, envie-o no Header como Authorization.

Exemplo de retorno de sucesso

{\n  \"status_code\": 200,\n  \"result\": {\n    \"api_token\": \"token-do-usuario\",\n    \"email\": \"email@mail.com.br\",\n    \"nome_usuario\": \"username\",\n    \"webhook_url\": null\n  }\n}\n

Exemplo de retorno de erro

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

\n","urlObject":{"protocol":"https","path":["usuario"],"host":["api-v2","idwall","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"b79937bc-2bf1-4a02-b70a-c82eaede45c7"}],"id":"aaf0a1ad-2b24-4c97-a4e2-8beb09b6f25a","description":"

As rotas de usuário são usadas para gerenciamento de suas credenciais nos serviços da IDwall.

A principal informação associada ao seu usuário é seu Token de acesso, ele deve ser enviado no Header de todas as solicitações que forem feitas para endpoints autenticados. Lembre-se que essa chave é pessoal e intransferível.

\n","_postman_id":"aaf0a1ad-2b24-4c97-a4e2-8beb09b6f25a"}]}