GuiasReferência de API

KYC

Know Your Customer (Conheça seu cliente)

Como somos regulados pelo Banco Central, temos a responsabilidade de realizar uma análise de documentos e procedimentos chamados KYC (Know Your Customer). Essa análise é realizada com cuidado, internamente para evitar fraudes, principalmente falsidade ideológica.

Nesse processo, solicitamos algumas informações além dos dados já enviados pelo cliente, como fotos frontais e fotos de documentos. Todas as informações são analisadas para que o cadastro do usuário seja aprovado ou não.

Com todas as validações feitas e aprovadas, o usuário terá sua conta aberta e pronta para uso.

Para entender melhor nosso processo de KYC, nossas etapas estão descritas abaixo:

Etapas via kyc webapp 📝

Neste modelo boa parte do fluxo de KYC é delegado para um Webapp hospedado por nós, o usuário começa o fluxo na sua plataforma/aplicativo, você deve então gerar e exibir um QRCode e/ou link para que o usuário finalize o envio de imagens e alguns dados via Webapp.

  1. Criar uma conta
  2. Gerar QRCode que ao ser escaneado levará o usuário para realizar o KYC através do WebApp da Stone.
  3. O WebApp KYC cuidará de solicitar e enviar as fotos do documento (frente e verso do Registro Geral (RG) ou a Carteira Nacional de Habilitação (CNH)) e de selfie.

Agora o usuário final aguarda a validação de seus dados. No fluxograma abaixo é possível entender a ordem das etapas via webapp Stone, da criação de conta até o envio das informações necessárias para o KYC.

Fluxo de KYC via Webapp Stone

Etapas via API-only 📝

Neste modelo você ficará responsável por criar todo o frontend do fluxo de KYC (seguindo alguns de nossos guidelines e regras), fazendo toda integração e envio de dados/imagens pela nossa API.

  1. Criar uma conta.
  2. Fazer o upload das fotos do documento escolhido. Eles podem ser o Registro Geral (RG) ou a Carteira Nacional de Habilitação (CNH).
  3. Chamar a rota que solicita uma validação de Conta.Com essa rota, o usuário pode enviar as informações necessárias para finalizar seu cadastro. Porém, há uma diferenciação entre pessoa física (PF) e pessoa jurídica (PJ).
OwnerOperadordate_of_birthEndereço
Pessoa física (PF)Dados do dono da conta.Dados do dono da conta. O dado se repete.Data de nascimento do usuário.Este dado também é obrigatório.
Pessoa jurídica (PJ)Fornecer os dados da própria empresa (CNPJ, Razão Social, etc.)A pessoa que vai administrar a conta. É recomendável que o operador da conta seja um dos sócios administrador da empresa.Data de criação da empresa.Este dado também é obrigatório

Agora o usuário final aguarda a validação de seus dados. No fluxograma abaixo é possível entender a ordem das etapas, da criação de conta até o envio das informações que faltavam.

Fluxo de KYC via API-only

Status da Validação 🏁

Nossa API possui 4 possíveis status de validação de KYC:

  • pending - KYC está pendente e no processo de análise, aqui é necessário aguardar até ter um feedback, onde o KYC será alterado para algum dos status abaixo;
  • approved - KYC foi aprovado e sua conta de pagamento foi criada, estando pronta para transacionar;
  • partially_denied - negado parcialmente pois necessita de documentos adicionais para validarmos a veracidade dos dados informados (mais explicado abaixo na seção onde listamos os motivos para esse status);
  • denied - KYC foi negado por algum problema com as imagens ou dados enviados, essencial verificar o motivo para entender com mais precisão o porquê a análise foi negada e como prosseguir.

Abaixo estão documentados os motivos dos status do KYC (campo status_reason da API). Eles estão separados por status, indicando seu código da forma que é retornado na API com uma descrição do seu significado, e quando aplicável qual ação tomar para prosseguir a análise.

Status de ValidaçãoMotivo (status_reason)Descrição
pendingwaiting_analysisMotivo inicial de um KYC, indica que o KYC está em aguardando para iniciar a análise;
pendingin_analysisquando o KYC está em processo de análise;
pendingwaiting_payment_accountMapeia um cenário de exceção, onde o KYC é aprovado, mas não conseguimos ou ocorreu um atraso na geração da conta de pagamento. É um cenário de baixa ocorrência e geralmente está associado a algum problema de comunicação interna dos sistemas. Nesses casos é recomendado aguardar algumas horas, pois pode ser só um atraso na criação da conta. Caso esteja há muito tempo nessa situação, o recomendado é entrar em contato conosco para analisarmos;
approvedokIndica que o KYC foi aprovado e a conta de pagamento criada;
partially_deniedadditional_documents_requiredIndica que é necessário enviar fotos de outros documentos para seguirmos a análise do KYC. Na próxima sessão o passo a passo para finalizar o KYC nesse cenário é explicado com mais detalhes;
deniedinvalid_selfieIndica que foi encontrado um problema na selfie, geralmente problemas com a qualidade da imagem. Nesses casos o recomendado é pedir ao usuário uma nova selfie, com atenção a iluminação, acessórios, etc. e enviar um novo KYC com a selfie nova;
deniedinvalid_dataIndica que foi encontrado um problema com os dados digitados, por exemplo CPF/CNPJ inválido. É recomendado pedir ao usuário que revise os dados informados e seja feito um novo KYC com os dados revisados;
deniedinvalid_photoIndica que foi encontrado um problema nas fotos dos documentos, por problemas de qualidade da imagem, tornando difícil validar os dados ou a foto contida no documento. Nesses casos o recomendado é pedir ao usuário novas fotos da frente e verso e enviar um novo KYC com as imagens novas;
deniedduplicate_accountIndica um cenário onde o usuário já possuí uma conta de pagamento Stone, atualmente não conseguimos abrir uma conta nova no mesmo documento, ao menos que a conta antiga seja cancelada;
deniedfully_deniedIndica uma situação onde o KYC foi negado sem abrir possibilidade para reenvio. Geralmente caindo em uma regra;
deniedgeneral_errorMapeia um cenário de exceção, onde rejeitamos o KYC mas não identificamos o motivo. É raro termos esse caso, historicamente a proporção de ocorrência desse motivo é menor que 0,01%.

Solicitação parcialmente negada? Passo a passo para solicitar um novo KYC 🤝

Esse cenário é um fluxo de exceção, que ocorre apenas em contas PJ, quando não foi possível validar que o operador declarado tem os poderes necessários para abrir e operar uma conta desta empresa/CNPJ. Com isso, pedimos fotos de alguns documentos adicionais, pode ser requisitado os seguintes documentos:

CampoDescrição
letter_of_attorneyFoto da procuração
social_contract_photosFoto do contrato social

É necessário seguir as etapas de envio de novos documentos:

Etapas via kyc webapp

  1. Gerar QRCode que ao ser escaneado levará o usuário para realizar o KYC através do WebApp da Stone.
  2. O WebApp KYC cuidará de tratar casos de exceção, como os fluxos de rejeite parcial que pedem documentos adicionais de procuração e/ou contrato social nos casos de CNPJ.

Etapas via API-only

  1. Primeiro é preciso chamar rota que lista quais documentos adicionais estão sendo pedidos pois ela retorna os documentos que precisam ser enviados. Neste caso, pode ser requisitado os seguintes documentos:
  2. Enviar as fotos dos documentos na rota de upload (mesma rota usada para envio das selfies, frente e verso do documento);
  3. Com os IDs recebidos no passo anterior, é necessário enviá-los para análise na rota de envio de documentos adicionais;

Conta de Pagamento

Feito o envio, o KYC voltará para análise e um novo feedback será dado. Somente quando a conta é aprovada, os dados bancários são gerados e a conta se torna transacionável.

Para saber mais sobre o conceito de account da API de baas consulte a nossa página de contas