Ícone Procob Lista Telefônica

Ícone Procob Contratar

Traz informações básicas de moradores do endereço pesquisado. Essa pesquisa pode ser refinada de acordo com a quantidade de parâmetros passados como CEP, nome, cidade, estado, e etc.

O que é? Consulta de informações sobre Pessoas Físicas e Jurídicas.
A quem se destina? Empresas que necessitam buscar e confirmar dados de Pessoas Físicas ou Jurídicas pelo nome ou endereço.
Formas de acesso Consulta Online (usuário/senha);
Web Services (SOAP / HTTPS);
Traz quais informações? CEP, Nome, Endereço/Localização

Parâmetros

  • =
  • =
  • =
  • Filtros

  • =
  • =
  • =
  • =
  • =
  • =
  • =
  • =
  • =
  • =
  • =
  • =
  • Pelo menos um campo deve ser preenchido!

    Resposta Linha Padrão

    URL Requisitada:

    Parâmetros

    Nome Tipo Formato Descrição Obrigatório?
    nome_pesquisado string [\w+ ]+ Nome a ser pesquisado. NAO
    cep integer ^\d{8}$ CEP a ser pesquisado. NAO
    endereco string [\w+ ]+ Endereço a ser pesquisado. NAO

    Filtros

    Parâmetro Tipo Formato Descrição Obrigatório?
    cidade string [\w+ ]+ Cidade a ser pesquisada. NAO
    uf string ^(\w{2})$ UF a ser pesquisada. NAO
    numero_inicial integer ^\d{8}$ Número inicial do endereço pesquisado. Caso não informe o numero final será considerado como número único. NAO
    numero_final integer ^\d{8}$ Número final do endereço pesquisado. Caso não informe o numero inicial será considerado como número único. NAO
    tipo_documento string (PF|PJ) Tipo de pessoa a ser pesquisada. Caso não informado o tipo de pessoa, a busca irá contemplar ambos os tipos. NAO
    idade_inicial integer ^\d{3}$ Idade inicial da pessoa/empresa pesquisada. Caso não informe a idade final será considerada como idade única. NAO
    idade_final integer ^\d{3}$ Idade final da pessoa/empresa pesquisada. Caso não informe a idade inicial será considerada como idade única. NAO
    agrupar_resultado string (SIM|NAO) Agrupar o resultado em um objeto podendo conter mais de um telefone e endereço. NAO
    tipo_consulta_telefone string (CELULAR|FIXO|AMBOS) Tipo de telefone a ser pesquisado. Caso não informado a busca irá considerar ambos os telefones. NAO
    tipo_consulta_nome string (FIXAR_PRIMEIRO_NOME|IDENTICO|SEMELHANTE|SOM_SEMELHANTE) Tipo de consulta nome a ser realizada. A opção FIXAR_PRIMEIRO_NOME irá buscar nomes identicos ao primeiro nome da sentença e resultados parecidos para os nomes seguintes da mesma sentença. A opção IDENTICO irá buscar nomes identicos ao nome da sentença. A opção SEMELHANTE irá buscar nome semelhante ao da sentença. A opção SOM_SEMELHANTE faz uma busca pela semelhança da pronuncia da sentença. Caso o campo não seja informado será considerado a opção SEMELHANTE como default. NAO
    tipo_consulta_endereco string (IDENTICO|SEMELHANTE|SOM_SEMELHANTE) Tipo de consulta de endereço a ser realizada. A opção IDENTICO irá buscar nomes identicos ao nome da sentença. A opção SEMELHANTE irá buscar nome semelhante ao da sentença. A opção SOM_SEMELHANTE faz uma busca pela semelhança da pronuncia da sentença. . Caso o campo não seja informado será considerado a opção SEMELHANTE como default. NAO
    sexo string (MASCULINO|FEMININO|AMBOS) Tipo de sexo a ser pesquisado. Caso não infomado a busca irá considerar ambos os sexos. NAO

    Ícone Procob Autenticação

    Todas as chamadas a API devem ser autenticadas, o formato escolhido é a autenticação basic através do header Basic Authorization. Nesse header é enviado o email concatenado por dois pontos (:) mais a senha, tudo junto sem espaços. Esse conteúdo é convertido para uma chave usando algoritmos de base 64, ficando como o exemplo abaixo:

    Authorization: Basic UUAN5678e9WsdDdsSaD54854=

    É possível gerar o valor a ser enviado no cabeçalho através do comando unix abaixo:

    echo -n conta:Senha | base64

    É possível fazer esse procedimento através do site base64Encode gratuitamente.

    Para realizar os testes aqui no Sandbox basta preencher o usuário e senha no formulário no topo superior direito da página.

    Ícone Procob Request

    Separamos alguns exemplos de requisição em diversas linguagens de programação que retorna somente se a comunicação foi bem sucedida.

    var client = new RestClient("https://api.procob.com/consultas/teste");
    var request = new RestRequest(Method.GET);
    request.AddHeader("authorization", "Basic c2FuZGJveEBwcm9jb2IuY29tOlRlc3RlQXBp");
    IRestResponse response = client.Execute(request);
    
    package main
    
    	import (
    		"fmt"
    		"net/http"
    		"io/ioutil"
    	)
    
    	func main() {
    
    		url := "https://api.procob.com/consultas/teste"
    
    		req, _ := http.NewRequest("GET", url, nil)
    
    		req.Header.Add("authorization", "Basic c2FuZGJveEBwcm9jb2IuY29tOlRlc3RlQXBp")
    
    		res, _ := http.DefaultClient.Do(req)
    
    		defer res.Body.Close()
    		body, _ := ioutil.ReadAll(res.Body)
    
    		fmt.Println(res)
    		fmt.Println(string(body))
    
    	}
    
    package javaapplication1;
    
    import java.io.BufferedReader;
    import java.io.IOException;
    import java.io.InputStreamReader;
    import java.net.HttpURLConnection;
    import java.net.MalformedURLException;
    import java.net.URL;
    
    /**
     *
     * @author anderson
     */
    public class JavaApplication1 {
    
        public static final String HOST = "https://api.procob.com";
        
        /**
         * @param args the command line arguments
         */
        public static void main(String[] args) throws MalformedURLException, IOException {
            
            String path = "/consultas/teste";
            
            URL obj = new URL(HOST + path);
            
            HttpURLConnection con = (HttpURLConnection) obj.openConnection();
            
            con.setRequestMethod("GET");
            con.setRequestProperty("Authorization", "Basic c2FuZGJveEBwcm9jb2IuY29tOlRlc3RlQXBp");
            
            BufferedReader in = new BufferedReader(
    		        new InputStreamReader(con.getInputStream()));
    		String inputLine;
    		StringBuilder response = new StringBuilder();
    
    		while ((inputLine = in.readLine()) != null) {
    			response.append(inputLine);
    		}
    		in.close();
    
    		System.out.println(response.toString());
        }
    }
    
    var http = require("https");
    
    var options = {
      "method": "GET",
      "hostname": "api.procob.com",
      "port": 443,
      "path": "/consultas/teste",
      "headers": {
        "authorization": "Basic c2FuZGJveEBwcm9jb2IuY29tOlRlc3RlQXBp",
      }
    };
    
    var req = http.request(options, function (res) {
      var chunks = [];
    
      res.on("data", function (chunk) {
        chunks.push(chunk);
      });
    
      res.on("end", function () {
        var body = Buffer.concat(chunks);
        console.log(body.toString());
      });
    });
    
    req.end();
    
    #import <Foundation/Foundation.h>
    
    NSDictionary *headers = @{ @"authorization": @"Basic c2FuZGJveEBwcm9jb2IuY29tOlRlc3RlQXBp"};
    
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://api.procob.com/consultas/teste"]
                                                           cachePolicy:NSURLRequestUseProtocolCachePolicy
                                                       timeoutInterval:10.0];
    [request setHTTPMethod:@"GET"];
    [request setAllHTTPHeaderFields:headers];
    
    NSURLSession *session = [NSURLSession sharedSession];
    NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
                                                completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
                                                    if (error) {
                                                        NSLog(@"%@", error);
                                                    } else {
                                                        NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
                                                        NSLog(@"%@", httpResponse);
                                                    }
                                                }];
    [dataTask resume];
    
    <?php
    
    $curl = curl_init();
    
    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://api.procob.com/consultas/teste",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_ENCODING => "",
      CURLOPT_MAXREDIRS => 10,
      CURLOPT_TIMEOUT => 30,
      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
      CURLOPT_CUSTOMREQUEST => "GET",
      CURLOPT_HTTPHEADER => array(
        "authorization: Basic c2FuZGJveEBwcm9jb2IuY29tOlRlc3RlQXBp"
      ),
    ));
    
    $response = curl_exec($curl);
    $err = curl_error($curl);
    
    curl_close($curl);
    
    if ($err) {
      echo "cURL Error #:" . $err;
    } else {
      echo $response;
    }
    
    import http.client
    
    conn = http.client.HTTPConnection("api.procob.com")
    
    headers = {
        'authorization': "Basic c2FuZGJveEBwcm9jb2IuY29tOlRlc3RlQXBp"
        }
    
    conn.request("GET", "/consultas/teste", headers=headers)
    
    res = conn.getresponse()
    data = res.read()
    
    print(data.decode("utf-8"))
    
    require 'uri'
    require 'net/http'
    
    url = URI("https://api.procob.com/consultas/teste")
    
    http = Net::HTTP.new(url.host, url.port)
    
    request = Net::HTTP::Get.new(url)
    request["authorization"] = 'Basic c2FuZGJveEBwcm9jb2IuY29tOlRlc3RlQXBp'
    
    response = http.request(request)
    puts response.read_body
    
    import Foundation
    
    let headers = [
      "authorization": "Basic c2FuZGJveEBwcm9jb2IuY29tOlRlc3RlQXBp"
    ]
    
    var request = NSMutableURLRequest(URL: NSURL(string: "https://api.procob.com/consultas/teste")!,
                                            cachePolicy: .UseProtocolCachePolicy,
                                        timeoutInterval: 10.0)
    request.HTTPMethod = "GET"
    request.allHTTPHeaderFields = headers
    
    let session = NSURLSession.sharedSession()
    let dataTask = session.dataTaskWithRequest(request, completionHandler: { (data, response, error) -> Void in
      if (error != nil) {
        println(error)
      } else {
        let httpResponse = response as? NSHTTPURLResponse
        println(httpResponse)
      }
    })
    
    dataTask.resume()
    

    Ícone Procob Retorno

    Caso o retorno seja de sucesso, você irá receber um JSON como o exibido abaixo:

    {
        "code": "000",
        "message": "Consulta de testes com dados fictícios",
        "date": "2019-06-26",
        "hour": "19:06:21",
        "content": [
            {
                "documento": "99999999999999",
                "nome": "FULANO DETAL - MEI",
                "ddd": "99",
                "telefone": "99999999",
                "logradouro": "R",
                "endereco": "RUA TESTE",
                "numero": "9",
                "complemento": "",
                "bloco": "",
                "apartamento_conjunto": "",
                "bairro": "9",
                "cep": "99999999",
                "cidade": "PARQUE ESPLANADA III",
                "uf": "VALPARAISO DE GOIAS",
                "operadora": "VIVO FIXO",
                "tipopessoa": "PJ",
                "sexo": "",
                "idade": "9"
            },
            {
                "documento": "99999999999999",
                "nome": "SICRANO LTDA",
                "ddd": "99",
                "telefone": "999999999",
                "logradouro": "",
                "endereco": "AV C 999",
                "numero": "9",
                "complemento": "QUADRA 999 LOTE 99",
                "bloco": "",
                "apartamento_conjunto": "",
                "bairro": "9",
                "cep": "99999999",
                "cidade": "JARDIM AMERICA",
                "uf": "GOIANIA",
                "operadora": "VIVO - CELULAR",
                "tipopessoa": "PJ",
                "sexo": "",
                "idade": "9"
            }
        ]
    }

    A resposta da API se da sempre em um bloco contendo o código da resposta, a mensagem, a data e hora da consulta e o conteúdo da consulta efetuada, caso ele exista.

    Segue abaixo a lista de retornos disponíveis:

    Código Mensagem
    000 Pesquisa feita com sucesso
    001 Nao encontramos registros para a pesquisa
    002 Seus creditos são inferiores ao valor da consulta
    003 Tipo de documento invalido para está consulta
    004 Sem informacoes disponiveis
    005 É necessario passar parametros via GET
    006 O fornecedor desta consulta se encontra em manutencao, favor tentar daqui alguns minutos
    007 Produto se encontra em manutencao, favor tentar daqui alguns minutos
    008 Usuário ou senha invalidos
    009 Operacao realizada com sucesso
    010 Usuario não cadastrado
    011 Usuario não cadastrado via rede social especificada
    012 Data de nascimento obrigatório para o documento informado
    900 Ocorreu um erro de execucao, favor contatar o suporte Procob
    999 Mensagem generica usada para diversos retornos na API