Nome da tab
Apresentação
Título
O que é ?
Text

     API KYC Fill-In, desenvolvida conforme o padrão internacional da Camara (GSMA), versão 0.1.0. A API tem como finalidade permitir que empresas clientes (B2B) realizem o preenchimento automatizado de dados cadastrais a partir do número de telefone (MSISDN), com base em dados previamente autorizados e legalmente tratados pela Claro.

A solução permitirá o retorno de atributos como:

  • Nome completo
  • CPF
  • Data de nascimento
  • Endereço
  • E-mail

Essa API visa melhorar os processos de onboarding digital, reduzir fraudes de identidade e aumentar a conversão de cadastros por parte das empresas contratantes.

 

Título
Beneficios
Ícone
Título
Fácil Integração
Text

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.

Ícone
Título
Aumento de Segurança
Text

Os retornos fornecidos, quando vinculados a outras medidas, podem se tornar meios eficazes de evitar que sejam praticadas fraudes, minimizando assim, o seu impacto no ambiente de negócios.

Ícone
Título
Principais ganhos
Text

• Validação em tempo real dos dados fornecidos.
• Acesso a informações verificadas pela Operadora.
• Garantia de precisão e segurança nos processos de verificação.
• Total conformidade com as regulamentações de privacidade.

Melhore a qualidade dos dados, reduza fraudes e ofereça uma experiência mais confiável para seus usuários com a nossa solução robusta e eficiente. Integre facilmente e eleve o nível de confiabilidade do seu serviço!

Título
Dúvidas frequentes

Como funciona a cobrança?

A cobrança é feita por consulta com sucesso e com entrega de informações. Se ao menos um dos dados dos campos for fornecido, a consulta será considerada um sucesso para fins de faturamento.

Como é feita a integração?

A integração é feita por meio de API e toda a documentação está disponível aqui no portal! 

Qual a informação chave para retorno dos dados da KYC Fill in?

O input obrigatório para devolutiva das informações é o MSISDN (número de telefone).

Qual a diferença desta API para o KYC Match?

A API de KYC Match realiza a comparação entre os dados cadastrais fornecidos com a base da Operadora, retornando um true ou false. Enquanto a KYC Fill-In informa os dados corretos cadastrados em nossa base.

Com que frequência o dado é atualizado?

Diariamente.

Nome da tab
Documentação
Título
API Know Your Customer Fill In
Text

Versão: 0.2.1

Criada por: Claro | GSMA Opengateway

Data: 02/12/2025

Passo a passo

Caso ainda tenha duvidas, baixe o PDF abaixo com o tutorial de integração da API Know Your Customer Fill In. Ele te explica passo a passo como utilizá-la.

Título
Documentação:
Text

Em caso de duvidas técnicas por favor entre em contato através do Fale conosco


 

Título
Respostas

200 -A solicitação foi bem-sucedida. A resposta contém o resultado da validação dos dados do cliente.

400 - A solicitação não pôde ser entendida pelo servidor devido à sintaxe incorreta ou parâmetros inválidos. O cliente deve corrigir e reenviar a requisição.

401 - A solicitação requer autenticação. O token de acesso está ausente, inválido ou expirado.

403 - O servidor compreendeu a solicitação, mas se recusa a atendê-la. Pode ocorrer por falta de permissão, inconsistência nos dados ou token inválido para o contexto.

500- Erro interno do servidor. Um problema inesperado ocorreu no processamento da solicitação.

503 - O serviço está temporariamente indisponível. O cliente deve tentar novamente mais tarde.

504 - O servidor não conseguiu receber uma resposta a tempo para completar a solicitação. Recomenda-se tentar novamente.

Título
Passo a passo
Text

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.

Título
Códigos de Exemplo
Título
CURL
Text
#!/bin/bash
# URL de obtenção do token
url_token="https://api.claro.com.br/oauth2/v1/token"
# URL da API KYC Match
url_filin="https://api.claro.com.br/mobile/v1/gsma/gateway/kyc/fillin"
# Credenciais
key="XXXXXXXXXXXXXXXXXXXXXXXXX"
secret="XXXXXXXXXXXXXXXXXXXXX"
# Dados do cliente para validação
phoneNumber="+5511999999999"

# Gerar senha em base64
senha=$(echo -n "$key:$secret" | base64)
# Requisição para obter o token de acesso
token=$(curl -s -X POST "$url_token" \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H "Authorization: Basic $senha" \
  -d 'grant_type=client_credentials' | jq -r .access_token)
# Requisição para validar o KYC
curl -X POST "$url_filin" \
  -H "Authorization: Bearer $token" \
  -H "Content-Type: application/json" \
  -H "cache-control: no-cache" \
  -d '{
        "phoneNumber": "'"$phoneNumber"'"        
      }'

Trial

Começar por aqui!

Para você começar a desenvolver já!
•1.000 solicitações gratuitas
• Período de 3 meses
• Relatório de consumo

Contratar

Pay per use

Após o desenvolvimento

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