Introdução
Bem vindo à API de Onboarding da QI Tech! Esta API dá acesso aos serviços de Prevenção a Fraudes, à lavagem de dinheiro e de KYC em um Cadastro da sua plataforma!
Esta API pode ser utilizada para a validação cadastral de clientes para:
- Abertura de Contas Digitais ou Wallets
- Emissão de Cartão
- Validação de Usuários de Aplicativos
- Cadastro para Concessão de Crédito
- Cadastro para Contratação de Seguros
- Validação de Dados Cadastrais
Você pode utilizar a nossa API para acessar os endpoints para avaliar os seguintes tipos de Cadastro:
- Natural Person - utilizado para validação cadastral de Pessoas Físicas
- Legal Person - utilizado para validação cadastral de Pessoas Jurídicas
Os diferentes tipos de Cadastro acima possuem objetos e endpoints específicos com o intuito de cobrir as particularidades de cada entidade.
Como funciona
| Passo | Chamada | O que faz |
|---|---|---|
| 1 | POST /onboarding/natural_person ou /legal_person | Envia o cadastro; a QI Tech executa a sua árvore de decisão e devolve o resultado em analysis_status. |
| 2 | PUT /onboarding/{tipo}/{id} | Informa o desfecho na sua plataforma (client_status). Retroalimenta os modelos. |
| 3 | GET /onboarding/{tipo}/{id} | Consulta o estado atual e o histórico de eventos. |
Resultados assíncronos chegam por Webhook.
São apenas 3 campos obrigatórios em cada tipo de cadastro. Comece pelo payload mínimo em Natural Person ou Legal Person, com exemplos em Python, PHP, Node.js, Java, C# e curl.
As chaves devolvidas pelos SDKs entram em lugares diferentes em PF e PJ. Veja Dados do SDK.
Problemas?
Nós não somos uma companhia que se esconde atrás de uma API! Entre em contato com o nosso suporte e nós responderemos o mais rápido possível. Fique à vontade para nos ligar caso deseje uma resposta rápida!
Adoramos Feedback
Mesmo que você já tenha resolvido o seu problema ou que ele seja muito simples (Até mesmo um typo ou uma organização inadequada que você já notou), envie-nos um e-mail, assim nós tornamos a documentação cada vez mais prática e a próxima pessoa não vai precisar sofrer as dores que você sofreu!
Ambientes
Possuímos dois ambientes para os nossos clientes. As URLs base das APIs são:
- Produção -
https://api.caas.qitech.app/onboarding/ - Sandbox -
https://api.sandbox.caas.qitech.app/onboarding/
Não devem ser usados dados reais de pessoas físicas e/ou jurídicas nos ambientes de Sandbox da QI Tech.
No ambiente de Sandbox, as análises enviadas não são cobradas e são respondidas de acordo com a seguinte regra baseada no primeiro dígito do documento - CPF para Pessoas Físicas e CNPJ para Pessoas Jurídicas:
| Dígito | Decisão |
|---|---|
| 0 | Em Análise Manual |
| 1 | Em Análise Manual |
| 2 | Em Análise Manual |
| 3 | Em Análise Manual |
| 4 | Contestado Automaticamente |
| 5 | Derivado para Análise Manual - Com reprovação posterior |
| 6 | Derivado para Análise Manual - Com aprovação posterior |
| 7 | Pendente |
| 8 | Reprovado Automaticamente |
| 9 | Aprovado Automaticamente |
Nos casos de CPF ou CNPJ com início nos dígitos 1 ou 2, deve-se entrar em contato com nosso suporte para que a tratativa manual seja feita corretamente.
Somente HTTPS
Por questão de segurança, toda a comunicação com as APIs da QI Tech deve ser realizada utilizando a comunicação HTTPS. Para evitar que, por desatenção ou outro motivo, sejam feitas chamadas HTTP, este servidor somente disponibiliza a porta 443 com comunicação TLS 1.2. Chamadas realizadas utilizando outros protocolos serão automaticamente negadas.