Apresentação
O que é?

O Claro valida endereço utiliza informações altamente qualificadas de endereços para confirmar se os dados que compõe o endereço de residências dos clientes estão corretos. Ideal para empresas que precisam de retornos rápidos para: triar riscos, proteger os negócios de ações suspeitas e fraudulentas, garantir qualificação e credibilidade das informações cadastrais.

 

  • A entrega permite identificar se o CEP e/ou número de residência pertencem a determinado CPF, por meio de respostas conforme a combinação de match com a nossa base;

 

  • O acesso ocorre por meio da nossa API que permiti uma fácil integração com qualquer plataforma ou sistema de consulta;
Benefícios
Fácil integração

A nossa API é “restful”, ou seja, o nosso protocolo de comunicação foi criado de uma forma que pode interpretar qualquer linguagem de programação. Isso torna o processo de integração do lado dos nossos clientes e parceiros mais flexível e de fácil entendimento. Na página de documentação deixamos alguns exemplos de linguagem, caso seja necessário.

Aumento de receita

A utilização de validação cadastral associada a outras medidas protetivas, garantem resultados mais seguros e sustentáveis no ambiente de negócios. Dessa forma é possível, minimizar o risco de práticas de fraudes e de entradas de informações incorretas e não qualificadas nas empresas.

Diferenciais
  • Validação em tempo real: agilidade nos processos de confirmação das informações, reduzindo esforço humano manual;

 

  • Facilidade para o negócio: o retorno são descrições de simples entendimento para apoiar nas decisões de negócios;

 

  • Transparência: as informações são detalhadas e sinalizam o que está correto e incorreto nas informações fornecidas, garantindo maior confiança e segurança para as empresas.
Dúvidas frequentes

Como realizamos a consulta? (Webservice?)

 A consulta é realizada através de integração com nossa API ou através do portal.

A cobrança é por consulta?

Sim, a cobrança é feita por consulta com sucesso e com entrega de informações. Se ao menos um dos dados fornecidos na entrada for validado com 'true' ou 'false', a consulta será considerada um sucesso para fins de faturamento.

Documentação

Documentação
Claro Brasil - Customers Addresses Service - REST API

Versão: 1;2019-08-15

Criada por: Logicalis

Data: 15/08/2019

Modificações

  • [Claro API Monetization MVP] Versão inicial
Obtenha a precisão dos endereços dos clientes

Esta operação retorna um inteiro que expressa a probabilidade de que o cliente Claro endereços são confiáveis ​​para uso, bem como detalhes de riscos potenciais associados às partes do endereço fornecido. Backend: claro-api-managment.azure-api.net.

Respostas

200 - A solicitação foi bem sucedida.

400 - A solicitação não pôde ser entendida pelo servidor devido à sintaxe incorreta. O cliente NÃO DEVE repetir o pedido sem modificações.

401 - A solicitação requer autenticação do usuário.

403 - O servidor entendeu a solicitação, mas está se recusando a atendê-la.

404 - O servidor não encontrou nada que corresponda ao Request-URI.

500 - O servidor falhou ao atender uma solicitação aparentemente válida.

Passo a passo

Caso ainda restem dúvidas, baixe o PDF que contém o tutorial de consumo da API, que explica passo a passo como utiliza-la.

Baixar documentação
Códigos de Exemplo
CURL
!/bin/bash

url_validationsaddress=https://api.claro.com.br/customers/v1/validationsaddress
url_token=https://api.claro.com.br/oauth2/v1/token
addressZipCode="XXXXXXXX"
addressNumber="XXXX"
cpf="XXXXXXXXXXX"
key=XXXXXXXXXXXXXXXXXXXXXXXXXXXX
secret=XXXXXXXXX


senha=$( echo -n $key:$secret | base64)


curl -X POST $url_token  -H 'Content-Type: application/x-www-form-urlencoded' -H 'cache-control: no-cache' -d 'grant_type=client_credentials' -H "x-client-auth: Basic $senha" > json

grep 'access_token' json > atributoJson

token=$(cut -d'"' -f4 atributoJson )

curl -X POST $url_validationsaddress -H 'Content-Type: application/json' -H 'cache-control: no-cache' -H "x-client-auth: Bearer $token" -H "X-CustomerID: claro_exemplo"  -d '{"data": {"customer": {"addressZipCode": "'$addressZipCode'","addressNumber": "'$addressNumber'","cpf": "'$cpf'"}}}'
Java
Python
import requests, json
import base64

KEY="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
SECRET="XXXXXXXXXXXXX"

SENHA = base64.b64encode( (KEY + ':' + SECRET ).encode('ascii') ).decode('ascii')

GRANT_TYPE = "client_credentials";

URL = "https://api.claro.com.br";
END_POINT_ACCESS_TOKEN = "/oauth2/v1/token";
END_POINT_API_VALIDATIONSADDRESS = "/customers/v1/validationsaddress";

headers={'Content-Type':'application/x-www-form-urlencoded','cache-control':'no-cache','x-client-auth': 'Basic {}'.format(SENHA)}

data = {'grant_type': 'client_credentials'}

respToken = requests.post(URL + END_POINT_ACCESS_TOKEN , headers=headers , data= data)
if respToken.status_code != 200:
    print('Erro:' + str( respToken.status_code))
else:
    token = json.loads( respToken.text)['access_token']
    
    headers_app = {'Content-Type': 'application/json',
                   'X-CustomerID': 'claro_exemplo',
                   'cache-control':'no-cache',
                   'user-agent':'curl/7.60.0',
                   'x-client-auth': 'Bearer {}'.format(token)}
  
    addressZipCode="XXXXXXX"
    addressNumber="XXXXX"
    cpf="XXXXXXXXXXX"

    data_app = {"data": {"customer": {"addressZipCode": addressZipCode,"addressNumber": addressNumber ,"cpf": cpf}}}

    resp = requests.post( URL + END_POINT_API_VALIDATIONSADDRESS, headers=headers_app , data= json.dumps(data_app))

    if resp.status_code != 200:
        print('Erro: ' + str(resp.status_code))
    else:
        print('Válida ' + str( resp.text ))
PHP
$key = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXX';

$secret = 'XXXXXXXXXXXX';

$addressZipCode = 'XXXXXXXX';

$addressNumber = 'XXXXX';

$cpf = 'XXXXXXXXXXX';

$token = getAccessToken();

$validationsaddress = getValidationsAddress($token , $addressZipCode, $addressNumber , $cpf);

echo $validationsaddress;

function getAccessToken() {
   
   try{
	
	$senha = base64_encode($GLOBALS['key'] . ':' . $GLOBALS['secret']);

        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, "https://api.claro.com.br/oauth2/v1/token");
        curl_setopt( $ch, CURLOPT_HTTPHEADER, [
            'Content-Type: application/x-www-form-urlencoded',
            'x-client-auth: Basic ' . $senha
            
        ]);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLINFO_HEADER_OUT, true);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, 'grant_type=client_credentials');
        
        $response = curl_exec($ch);
     
        if (!$response){
            $error = curl_error($ch);
            $info = curl_getinfo($ch);
            die("cURL request failed, error = {$error}; info = " . print_r($info, true));
        }
        if(curl_errno($ch)){
            curl_close($ch);
            echo 'error:' . curl_error($ch);
        } else {
            curl_close($ch);
            return json_decode($response)->access_token;    
        }
    
    } catch (Exception $e) {
        return 'Erro '. $e;
    }
}


function getValidationsAddress($token , $addressZipCode, $addressNumber , $cpf){
    
    try {
        
	$payload = '{"data": {"customer": {"addressZipCode":' . $addressZipCode . ',"addressNumber": ' . $addressNumber .',"cpf": ' . $cpf . '}}}';
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, "https://api.claro.com.br/customers/v1/validationsaddress");
        curl_setopt( $ch, CURLOPT_HTTPHEADER, [
            'Content-Type: application/json',
	    'X-CustomerID: claro_exemplo',
            'x-client-auth: Bearer ' . $token
            
        ]);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLINFO_HEADER_OUT, true);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
      
        $response = curl_exec($ch);
  
        if (!$response){
            $error = curl_error($ch);
            $info = curl_getinfo($ch);
            die("cURL request failed, error = {$error}; info = " . print_r($info, true));
        }
        if(curl_errno($ch)){
            curl_close($ch);
            echo 'error:' . curl_error($ch);
        } else {
            curl_close($ch);
            return $response;        
        }
       
    } catch (Exception $e) {
        return 'Erro '. $e;
    }
}

Plano Trial

Para você comecar a desenvolver já!

  • 1000 requisições free
  • Período de 3 meses
  • Relatório de consumo
Teste sem pagar nada

Plano Pay Per Use

A melhor escolha para o seu negócio. Após testar nossa trial, você passa a consumir nosso plano em produção, cobrado por consumo conforme seu contrato.

Contratar