PIX ANTIFRAUDE

Última atualização: 22 de Maio de 2023

Introdução

O objetivo deste documento é apresentar as especificações técnicas e homologatórias para antifraude nos pagamentos instantâneos, solução desenvolvida e operada pela Clear que tem o objetivo de auxiliar na avaliação, pelos participantes, da confiabilidade de informações relacionadas aos usuários finais do PIX, buscando mitigar o risco de fraude em transações no âmbito do PIX.

A plataforma foi elaborada para ser utilizada pelo ecossistema de pagamentos instantâneos brasileiro como um todo, utilizando um conceito de base compartilhada. Quanto mais participantes estiverem integrados à solução, mais seguro será o sistema. Ao mesmo tempo, permite autonomia e controle total dos participantes terem sua própria gestão de risco, recebendo os melhores insumos para tomada de decisão

Descrição do Produto

O antifraude PIX foi desenvolvido exclusivamente para auxiliar as Instituições Financeiras na tomada de decisão e avaliação do risco das informações relacionadas aos processos de criação da chave pix, análise transacional de pagadores e recebedores.

O antifraude PIX realiza esse processo de análise e verificação do risco utilizando basicamente 3 ferramentas:

  • Score: medida relacionada ao risco de fraude, quanto maior o número gerado pelo score, maior o risco de fraude.
  • Ratings: valor de vínculo entre as variáveis que é apresentado de 0 a 3, onde: 0 é igual a vínculo inexistente e 3 é igual vínculo forte.
  • Insights: são informações sobre os dados enviados, podendo ser positivos, neutros ou alertas, baseados no histórico, combinados ou isolados, desses dados no Data Lake da ClearSale.

Segurança

Todas as requisições submetidas à nossa API devem ser realizadas através de um token gerado através de um usuário, senha e id da entidade que devem ser fornecidos pela Clear.

Na autenticação, além do token retornamos seu tempo de expiração. É necessário que contemple no seu desenvolvimento o gerenciamento da vida útil do token com base nesse tempo de expiração. Só gere um novo token após a expiração do seu token atual.

O acesso aos serviços é feito através de API REST, usando padrões de mercado seguros.

Funcionalidades Disponíveis

Abaixo seguem as funcionalidades disponíveis para utilização no Serviço Antifraude para Pagamentos Instantâneos:

  • Entry: Análise de cadastros de chaves
  • Transfer: Análise de transações do lado pagador
  • Feedbackentry: Retroalimentação de cadastros de chaves
  • Feedbacktransfer: Retroalimentação de transações
  • Feedbackfraud: Retroalimentação de marcações de fraudes
  • 2FA: Segundo fator de autenticação
  • SimSwap: Análise de troca de chips(SimCards)
  • Receiver: Análise de transações do lado recebedor
  • Antifraud: Análise de transações

Fluxo de Integração

Homologação

Pré-requisitos:

Adesão aos serviços;

Envio dos documentos de Matriz de Funcionalidades, Cadastro de Contatos e Cadastro Técnico para o e-mail suporte.pix@clear.sale;

Após os requisitos acima devidamente atendidos e validados, a Clear enviará o usuário e senha para acesso.

Hostname Homologação:

https://afpi-hmg.sec-hub.com.br

Observação:

Recomendamos não enviar dados produtivos nos testes do ambiente de homologação. Os dados retornados no ambiente de homologação são aleatórios e fictícios.

Produção

Pré-requisitos:

Adesão aos serviços;

Envio dos documentos de Matriz de Funcionalidades, Cadastro de Contatos e Cadastro Técnico para o e-mail suporte.pix@clear.sale;

Após os requisitos acima devidamente atendidos e validados, a Clear enviará o usuário e senha para acesso.

Hostname Produção:

https://afpi.sec-hub.com.br/

Tratamento de Erro

401 - Não autorizado:

Possíveis problemas: erro ao autenticar a requisição. Consulte o valor do token.

400 - BadRequest:

Possíveis problemas: verifique se algum campo no corpo da requisição não está preenchido.

500 Internal Server Error

Possíveis problemas: algum tipo de problema está afetando o desempenho do servidor que você está tentando acessar.

SLA

Disponibilidade:

A Clear garante uma disponibilidade do software antifraude para pagamentos instantâneos (AFPI) de 98% (noventa e oito por cento) ao mês.

AFPI - Tempo de Resposta (apuração mensal):

Entende-se por tempo de resposta: Tempo dispendido entre o recebimento de uma requisição e envio da resposta.

Inicia-se assim que a mensagem é recebida pelo sistema na internet e é cessada assim que a mensagem de resposta deixa a plataforma.

98% das respostas até 2 segundos.

Adicional 2FA

Envio da mensagem SMS em até 60 segundos após a solicitação, desde que o telefone principal da pessoa esteja cadastrado na nossa base. Inicia-se assim que a solicitação é recebida pelo sistema na internet e é cessada assim que a mensagem de SMS deixa a plataforma.

Notificação via webhook da resposta do usuário em até 60 segundos após recebimento do SMS. Inicia-se assim que a resposta do usuário é recebida pelo sistema na internet e é cessada assim que a notificação via webhook deixa a plataforma. Obs.: No SLA não está sendo computado manutenções preventivas programadas e informadas previamente.

Swagger

Será possível visualizar as regras no swagger através deste link =>

Autenticação

Este endpoint está disponível na API na seguinte rota "/v1/authentication".

Todas as requisições submetidas à API devem ser realizadas utilizando um token, gerado a partir de um usuário e senha que serão fornecidos pela ClearSale.

Na autenticação, é retornado o token e seu tempo de expiração em segundos. É necessário que contemple no seu desenvolvimento o gerenciamento da vida útil do token com base nesse tempo de expiração. Somente gere um novo token após a expiração do seu token atual.

Parâmetros

Nome Valor Tipo Obrigatório
Username usuario_automatico String Sim
Password senha12345 String Sim

Entry - Post - Análise de cadastros de chaves

Este endpoint está disponível na API na seguinte rota "v1/analysis/entries". Tem a finalidade de receber dados relacionados ao cadastro de uma chave Pix e gerar resultados de score de risco, insights e força de vínculo dos dados relacionados.

Parâmetros

Nome Valor Tipo Obrigatório
reason USER_REQUESTED String Sim
requestId 1a2bdcb0-c8a8-464e-929d-6c93f8a2a143 String Não
name João Silva String Sim
document 18356615801 String Sim
documentType CPF String Sim
phone [object Object] Object Opcional
email fulano.tal@email.com.br String Não
verifiedEmail false Boolean Sim
address [object Object] Object Opcional
evp String Não
keyType EMAIL String Sim
account [object Object] String Sim
referenceDate 2021-12-28T14:49:56.9115638+00:00 String Sim
sessionId mysessionid-4-d3v1c3 String Não
statistics [object Object] String Não
fingerprintVariables [object Object] String Não
Phone
Nome Valor Tipo Obrigatório
countryCode 55 Integer Sim
areaCode 51 Integer Sim
number 999999999 Integer Sim
verified True Boolean Sim
Address
Nome Valor Tipo Obrigatório
zipCode 90660101 String Sim
street Rua Saudável 123 String Não
number 555 String Não
complement apto 123 String Não
district 90660101 String Não
city Rio de Janeiro String Não
state Rio de Janeiro String Não
country Brasil String Não
Account
Nome Valor Tipo Obrigatório
participant 56 String Sim
branch 55997874 String Não
accountNumber Brasil String Sim
accountType CACC String Não
openingDate 2019-10-18T14:49:56.9115638+00:00 String Sim
Statistics
Nome Valor Tipo Obrigatório
lastUpdated 2021-12-28T14:49:56.9115638+00:00 String Não
counters [Array] String Não
counters[0].FraudEventCounterDto.type CONFIRMED_FRAUDS String Sim
counters[0].FraudEventCounterDto.by KEY String Sim
counters[0].FraudEventCounterDto.d3 3 Integer Não
counters[0].FraudEventCounterDto.d30 4 Integer Não
counters[0].FraudEventCounterDto.m6 5 Integer Não

Entry - Get - Análise de cadastros de chaves

Este endpoint está disponível na API na seguinte rota "v1/analysis/entries/{id}". Tem a finalidade de buscar o resultado de uma análise feita através do ID de uma análise já feita anteriormente.

Transfer - Post - Análise de transações do lado pagador

Este endpoint está disponível na API na seguinte rota "v1/analysis/transfers". Tem a finalidade de receber dados relacionados a uma transferência/pagamento entre duas pessoas e gerar resultados de score de risco, insights e força de vínculo dos dados relacionados.

Parâmetros

Nome Valor Tipo Obrigatório
transactionType PACS.008 String Não
endToEndId E9999901012341234123412345678900 String Não
txId 90000 String Não
channel WEB String Sim
qrCode [object Object] Object Não
urlLink [object Object] Object Não
recipient [object Object] Object Sim
sender [object Object] Object Sim
currency BRL String Sim
amount 110.55 Number Sim
referenceDate 2023-05-16T13:53:34.6618625Z String Sim
QrCode
Nome Valor Tipo Obrigatório
value "00020101021126440014br.gov.bcb.pix0122fulano2019@example.com5204000053039865802BR5913FULANO DE TAL6008BRASILIA6304DFE3" String Sim
dynamicUrl [object Object] Object Não
DynamicUrl
Nome Valor Tipo Obrigatório
url http://bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8= String Sim
ip 127.0.0.1 String Sim
UrlLink
Nome Valor Tipo Obrigatório
url http://bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8= String Sim
ip 127.0.0.1 String Sim
Recipient
Nome Valor Tipo Obrigatório
account [object Object] Object Sim
statistics [object Object] Object Não
document 45985782000101 String Sim
documentType CNPJ String Sim
name João Silva String Não
tradeName Marca Comercial Exemplo String Não
key [object Object] Object Não
Account
Nome Valor Tipo Obrigatório
participant 56 String Sim
branch 55997874 String Não
accountNumber Brasil String Sim
accountType CACC String Não
openingDate 2019-10-18T14:49:56.9115638+00:00 String Sim
Statistics
Nome Valor Tipo Obrigatório
lastUpdated 2021-12-28T14:49:56.9115638+00:00 String Não
counters [Array] String Não
counters[0].FraudEventCounterDto.type CONFIRMED_FRAUDS String Sim
counters[0].FraudEventCounterDto.by KEY String Sim
counters[0].FraudEventCounterDto.d3 3 Integer Não
counters[0].FraudEventCounterDto.d30 4 Integer Não
counters[0].FraudEventCounterDto.m6 5 Integer Não
Key
Nome Valor Tipo Obrigatório
value 10770753000130 String Sim
type CNPJ String Sim
creationDate 2019-11-18T03:00:00+00:00 String Não
keyOwnershipDate 2019-11-18T03:00:00+00:00 String Não
openClaimCreationDate 2019-11-18T03:00:00+00:00 String Não
Sender
Nome Valor Tipo Obrigatório
phone [object Object] Object Não
email fulano.tal@email.com.br String Não
verifiedEmail false String Sim
address [object Object] Object Não
account [object Object] Object Sim
sessionId mysessionid-4-d3v1c3 String Não
fingerprintVariables String Não
document 45985782000101 String Sim
documentType CNPJ String Sim
name João Silva String Não
tradeName Marca Comercial Exemplo String Não
Phone
Nome Valor Tipo Obrigatório
countryCode 55 Integer Sim
areaCode 51 Integer Sim
number 999999999 Integer Sim
verified True Boolean Sim
Address
Nome Valor Tipo Obrigatório
zipCode 90660101 String Sim
street Rua Saudável 123 String Não
number 555 String Não
complement apto 123 String Não
district 90660101 String Não
city Rio de Janeiro String Não
state Rio de Janeiro String Não
country Brasil String Não

Transfer - Get - Análise de transações do lado pagador

Este endpoint está disponível na API na seguinte rota "v1/analysis/transfers/{id}". Tem a finalidade de buscar o resultado de uma análise feita através do ID de uma análise já feita anteriormente.

Feedbackentry - Post - Retroalimentação de cadastros de chaves

Este endpoint está disponível na API na seguinte rota "v1/feedback/entries". Tem a finalidade de receber dados relacionados ao cadastro de uma chave Pix e cadastrar as informações para base da solução sem gerar uma análise.

Parâmetros

Nome Valor Tipo Obrigatório
transactionType PACS.008 String Não
endToEndId E9999901012341234123412345678900 String Não
txId 90000 String Não
channel WEB String Sim
qrCode [object Object] Object Não
urlLink [object Object] Object Não
recipient [object Object] Object Sim
sender [object Object] Object Sim
currency BRL String Sim
amount 110.55 Number Sim
referenceDate 2023-05-16T13:53:34.6618625Z String Sim
QrCode
Nome Valor Tipo Obrigatório
value "00020101021126440014br.gov.bcb.pix0122fulano2019@example.com5204000053039865802BR5913FULANO DE TAL6008BRASILIA6304DFE3" String Sim
dynamicUrl [object Object] Object Não
DynamicUrl
Nome Valor Tipo Obrigatório
url http://bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8= String Sim
ip 127.0.0.1 String Sim
UrlLink
Nome Valor Tipo Obrigatório
url http://bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8= String Sim
ip 127.0.0.1 String Sim
Recipient
Nome Valor Tipo Obrigatório
account [object Object] Object Sim
statistics [object Object] Object Não
document 45985782000101 String Sim
documentType CNPJ String Sim
name João Silva String Não
tradeName Marca Comercial Exemplo String Não
key [object Object] Object Não
Account
Nome Valor Tipo Obrigatório
participant 56 String Sim
branch 55997874 String Não
accountNumber Brasil String Sim
accountType CACC String Não
openingDate 2019-10-18T14:49:56.9115638+00:00 String Sim
Statistics
Nome Valor Tipo Obrigatório
lastUpdated 2021-12-28T14:49:56.9115638+00:00 String Não
counters [Array] String Não
counters[0].FraudEventCounterDto.type CONFIRMED_FRAUDS String Sim
counters[0].FraudEventCounterDto.by KEY String Sim
counters[0].FraudEventCounterDto.d3 3 Integer Não
counters[0].FraudEventCounterDto.d30 4 Integer Não
counters[0].FraudEventCounterDto.m6 5 Integer Não
Key
Nome Valor Tipo Obrigatório
value 10770753000130 String Sim
type CNPJ String Sim
creationDate 2019-11-18T03:00:00+00:00 String Não
keyOwnershipDate 2019-11-18T03:00:00+00:00 String Não
openClaimCreationDate 2019-11-18T03:00:00+00:00 String Não
Sender
Nome Valor Tipo Obrigatório
phone [object Object] Object Não
email fulano.tal@email.com.br String Não
verifiedEmail false String Sim
address [object Object] Object Não
account [object Object] Object Sim
sessionId mysessionid-4-d3v1c3 String Não
fingerprintVariables String Não
document 45985782000101 String Sim
documentType CNPJ String Sim
name João Silva String Não
tradeName Marca Comercial Exemplo String Não
Phone
Nome Valor Tipo Obrigatório
countryCode 55 Integer Sim
areaCode 51 Integer Sim
number 999999999 Integer Sim
verified True Boolean Sim
Address
Nome Valor Tipo Obrigatório
zipCode 90660101 String Sim
street Rua Saudável 123 String Não
number 555 String Não
complement apto 123 String Não
district 90660101 String Não
city Rio de Janeiro String Não
state Rio de Janeiro String Não
country Brasil String Não

Feedbacktransfer - Post - Retroalimentação de transações

Este endpoint está disponível na API na seguinte rota /feedback/transfers". Tem a finalidade de receber dados relacionados a uma transferência/pagamento entre duas pessoas e cadastrar as informações para base da solução sem gerar uma análise.

Parâmetros

Nome Valor Tipo Obrigatório
transactionType PACS.008 String Não
endToEndId E9999901012341234123412345678900 String Não
txId 90000 String Não
channel WEB String Sim
qrCode [object Object] Object Não
urlLink [object Object] Object Não
recipient [object Object] Object Sim
sender [object Object] Object Sim
currency BRL String Sim
amount 110.55 Number Sim
referenceDate 2023-05-16T13:53:34.6618625Z String Sim
QrCode
Nome Valor Tipo Obrigatório
value "00020101021126440014br.gov.bcb.pix0122fulano2019@example.com5204000053039865802BR5913FULANO DE TAL6008BRASILIA6304DFE3" String Sim
dynamicUrl [object Object] Object Não
DynamicUrl
Nome Valor Tipo Obrigatório
url http://bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8= String Sim
ip 127.0.0.1 String Sim
UrlLink
Nome Valor Tipo Obrigatório
url http://bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8= String Sim
ip 127.0.0.1 String Sim
Recipient
Nome Valor Tipo Obrigatório
account [object Object] Object Sim
statistics [object Object] Object Não
document 45985782000101 String Sim
documentType CNPJ String Sim
name João Silva String Não
tradeName Marca Comercial Exemplo String Não
key [object Object] Object Não
Account
Nome Valor Tipo Obrigatório
participant 56 String Sim
branch 55997874 String Não
accountNumber Brasil String Não
accountType CACC String Não
openingDate 2019-10-18T14:49:56.9115638+00:00 String Sim
Statistics
Nome Valor Tipo Obrigatório
lastUpdated 2021-12-28T14:49:56.9115638+00:00 String Não
counters [Array] String Não
counters[0].FraudEventCounterDto.type CONFIRMED_FRAUDS String Sim
counters[0].FraudEventCounterDto.by KEY String Sim
counters[0].FraudEventCounterDto.d3 3 Integer Não
counters[0].FraudEventCounterDto.d30 4 Integer Não
counters[0].FraudEventCounterDto.m6 5 Integer Não
Key
Nome Valor Tipo Obrigatório
value 10770753000130 String Sim
type CNPJ String Sim
creationDate 2019-11-18T03:00:00+00:00 String Não
keyOwnershipDate 2019-11-18T03:00:00+00:00 String Não
openClaimCreationDate 2019-11-18T03:00:00+00:00 String Não
Sender
Nome Valor Tipo Obrigatório
phone [object Object] Object Não
email fulano.tal@email.com.br String Não
verifiedEmail false String Sim
address [object Object] Object Não
account [object Object] Object Sim
fingerprintVariables String Não
document 45985782000101 String Sim
documentType CNPJ String Sim
name João Silva String Não
tradeName Marca Comercial Exemplo String Não
Phone
Nome Valor Tipo Obrigatório
countryCode 55 Integer Sim
areaCode 51 Integer Sim
number 999999999 Integer Sim
verified True Boolean Sim
Address
Nome Valor Tipo Obrigatório
zipCode 90660101 String Sim
street Rua Saudável 123 String Não
number 555 String Não
complement apto 123 String Não
district 90660101 String Não
city Rio de Janeiro String Não
state Rio de Janeiro String Não
country Brasil String Não

Feedbackfraud - Post - Retroalimentação de marcações de fraude

Este endpoint está disponível na API na seguinte rota "v1/feedback/frauds". Tem a finalidade de receber dados relacionados a um alerta de fraude relacionado a alguma informação do contexto da nossa solução.

Parâmetros

Nome Valor Tipo Obrigatório
participant 87654321 String Sim
summary Fraude de roubo de whatsapp String Sim
description Fraude de roubo de whatsapp relatada pelo cliente em XX/YY/ZZZZ, nos ligou informando o modo de operação, o cliente recebeu uma mensagem... String Sim
visibility 1 Integer Sim
referenceDate 2021-12-28T14:49:56.9115638+00:00 String Sim
status 2 String Sim
relatedEntries [object Object] Object Sim
relatedTransfers [object Object] Object Sim
RelatedEntries
Nome Valor Tipo Obrigatório
entryId 4cbe1d0332f840c7ae716861dd866a8d String Sim
key [object Object] Object Não
account [object Object] Object Não
statistics [object Object] Object Não
RelatedTransfers
Nome Valor Tipo Obrigatório
transferId 4cbe1d0332f840c7ae716861dd866a8d String Sim
transactionType PACS.008 String Sim
endToEndId E9999901012341234123412345678900 String Sim
txId 90000 String Não
channel WEB String Não
qrCode [object Object] Object Não
urlLink [object Object] Object Sim
recipient [object Object] Object Sim
sender [object Object] Object Sim
currency BRL String Sim
amount 110.55 Number Sim
referenceDate 2021-12-28T14:49:56.9115638+00:00 String Sim
QrCode
Nome Valor Tipo Obrigatório
value "00020101021126440014br.gov.bcb.pix0122fulano2019@example.com5204000053039865802BR5913FULANO DE TAL6008BRASILIA6304DFE3" String Sim
dynamicUrl [object Object] Object Não
DynamicUrl
Nome Valor Tipo Obrigatório
url http://bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8= String Sim
ip 127.0.0.1 String Sim
UrlLink
Nome Valor Tipo Obrigatório
url http://bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8= String Sim
ip 127.0.0.1 String Sim
Recipient
Nome Valor Tipo Obrigatório
account [object Object] Object Sim
statistics [object Object] Object Não
document 45985782000101 String Sim
documentType CNPJ String Sim
name João Silva String Não
tradeName Marca Comercial Exemplo String Não
key [object Object] Object Não
Account
Nome Valor Tipo Obrigatório
participant 56 String Sim
branch 55997874 String Não
accountNumber Brasil String Não
accountType CACC String Não
openingDate 2019-10-18T14:49:56.9115638+00:00 String Sim
Statistics
Nome Valor Tipo Obrigatório
lastUpdated 2021-12-28T14:49:56.9115638+00:00 String Não
counters [Array] String Não
counters[0].FraudEventCounterDto.type CONFIRMED_FRAUDS String Sim
counters[0].FraudEventCounterDto.by KEY String Sim
counters[0].FraudEventCounterDto.d3 3 Integer Não
counters[0].FraudEventCounterDto.d30 4 Integer Não
counters[0].FraudEventCounterDto.m6 5 Integer Não
Key
Nome Valor Tipo Obrigatório
value 10770753000130 String Sim
type CNPJ String Sim
creationDate 2019-11-18T03:00:00+00:00 String Não
keyOwnershipDate 2019-11-18T03:00:00+00:00 String Não
openClaimCreationDate 2019-11-18T03:00:00+00:00 String Não
Sender
Nome Valor Tipo Obrigatório
phone [object Object] Object Não
email fulano.tal@email.com.br String Não
verifiedEmail false String Sim
address [object Object] Object Não
account [object Object] Object Sim
fingerprintVariables String Não
document 45985782000101 String Sim
documentType CNPJ String Sim
name João Silva String Não
tradeName Marca Comercial Exemplo String Não
Phone
Nome Valor Tipo Obrigatório
countryCode 55 Integer Sim
areaCode 51 Integer Sim
number 999999999 Integer Sim
verified True Boolean Sim
Address
Nome Valor Tipo Obrigatório
zipCode 90660101 String Sim
street Rua Saudável 123 String Não
number 555 String Não
complement apto 123 String Não
district 90660101 String Não
city Rio de Janeiro String Não
state Rio de Janeiro String Não
country Brasil String Não

2FA - Post - Segundo fator de autenticação

Este endpoint está disponível na API na rota "/v1/2fa/callback". Tem a finalidade de receber uma chamada sinalizando que houve resposta do SMS enviado para o Usuário.

Parâmetros

Nome Valor Tipo Obrigatório
documentType CPF String Sim
document 18356615801 String Sim
email fulano.tal@email.com.br String Não
verifiedEmail true Boolean Não
sessionId mysessionid-4-d3v1c3 String Não
address [object Object] Object Não
phone [object Object] Object Não
referenceDate 2023-05-16T13:53:35.7779413Z String Não
Phone
Nome Valor Tipo Obrigatório
countryCode 55 Integer Sim
areaCode 51 Integer Sim
number 999999999 Integer Sim
verified True Boolean Sim
Address
Nome Valor Tipo Obrigatório
zipCode 90660101 String Sim
street Rua Saudável 123 String Não
number 555 String Não
complement apto 123 String Não
district 90660101 String Não
city Rio de Janeiro String Não
state Rio de Janeiro String Não
country Brasil String Não

2FA - Get - Retorna informação do Segundo fator de autenticação

Este endpoint está disponível na API na seguinte rota "/v1/2fa/{id}". Tem a finalidade de obter um resultado de uma transação 2FA.

SimSwap - Post - Análise de troca de chips(SimCards)

Este endpoint está disponível na API na seguinte rota "/v1/simswap". Tem a finalidade de análisar do número de um telefone.

Parâmetros

Nome Valor Tipo Obrigatório
countryCode 55 String Sim
areaCode 11 String Sim
number 999999999 String Sim

SimSwap - Get - Retorna informação da análise de troca de chips(SimCards)

Este endpoint está disponível na API na seguinte rota "/v1/simswap/{id}". Tem a finalidade de buscar o resultado de uma análise de troca de chip através de um ID de uma solicitação feita anteriormente.

Receiver - Post - Análise de transações do lado recebedor

Este endpoint está disponível na API na seguinte rota "v1/analysis/receiver". Tem a finalidade de receber dados relacionados a uma transferência/pagamento entre duas pessoas e gerar resultados de score de risco, insights e força de vínculo dos dados relacionados. Este endpoint é referente as instituições recebedoras.

Parâmetros

Nome Valor Tipo Obrigatório
transactionType PACS.008 String Sim
endToEndId E9999901012341234123412345678900 String Sim
txId 90000 String Sim
recipient [object Object] String Sim
sender [object Object] String Sim
currency BRL String Sim
amount 110.55 Number Sim
referenceDate 2023-05-16T13:53:34.8320391Z String Sim
Recipient
Nome Valor Tipo Obrigatório
document 45985782000101 String Sim
documentType CNPJ String Sim
name João Silva String Sim
email teste@teste.com String Não
verifiedEmail True Boolean Sim
tradeName Marca Comercial Exemplo String Não
key [object Object] Object Não
address [object Object] Object Não
phone [object Object] Object Não
account [object Object] Object Sim
statistics [object Object] Object Não
Sender
Nome Valor Tipo Obrigatório
document 45985782000101 String Sim
documentType CNPJ String Sim
name João Silva String Sim
tradeName Marca Comercial Exemplo String Não
account [object Object] Object Sim
Key
Nome Valor Tipo Obrigatório
value 10770753000130 String Sim
type CNPJ String Sim
creationDate 2019-11-18T03:00:00+00:00 String Não
keyOwnershipDate 2019-11-18T03:00:00+00:00 String Não
openClaimCreationDate 2019-11-18T03:00:00+00:00 String Não
Recipient - Account
Nome Valor Tipo Obrigatório
participant 56 String Sim
branch 55997874 String Não
accountNumber Brasil String Sim
accountType CACC String Não
openingDate 2019-10-18T14:49:56.9115638+00:00 String Sim
Address
Nome Valor Tipo Obrigatório
zipCode 90660101 String Sim
street Rua Saudável 123 String Não
number 555 String Não
complement apto 123 String Não
district 90660101 String Não
city Rio de Janeiro String Não
state Rio de Janeiro String Não
country Brasil String Não
Phone
Nome Valor Tipo Obrigatório
countryCode 55 Integer Sim
areaCode 51 Integer Sim
number 999999999 Integer Sim
verified True Boolean Sim
Statistics
Nome Valor Tipo Obrigatório
lastUpdated 2021-12-28T14:49:56.9115638+00:00 String Não
counters [Array] String Não
counters[0].FraudEventCounterDto.type CONFIRMED_FRAUDS String Sim
counters[0].FraudEventCounterDto.by KEY String Sim
counters[0].FraudEventCounterDto.d3 3 Integer Não
counters[0].FraudEventCounterDto.d30 4 Integer Não
counters[0].FraudEventCounterDto.m6 5 Integer Não
Sender - Account
Nome Valor Tipo Obrigatório
participant 56 String Sim
branch 55997874 String Não
accountNumber Brasil String Sim
accountType CACC String Não

Receiver - Get - Retorna informação da análise de transações do lado recebedor

Este endpoint está disponível na API na seguinte rota "v1/analysis/receivers/{id}". Tem a finalidade de buscar o resultado de uma análise feita através do ID de uma análise já feita anteriormente.

Antifraud - Post - Análise de transações do pix

Este endpoint está disponível na API para seguinte rota "v1/analysis/antifraud". Tem a finalidade de analisar os dados relacionados entre dois participantes, podendo ser pessoa física o/ou jurídica e gerar resultados de score de risco de 0 a 1000.
Referente ao score, quanto maior o valor, maior será o risco de fraude e o mesmo vale inversamente.
Obs: Campos com obrigatoriedade "opcional" caso preenchido, será necessário preencher campos obrigatório que dependam do objeto pai. 

HTTP/1.1 200 Ok
Content-Type: application/json; charset=utf-8
{
  "operationType": 1,
  "cashType": 1,
  "recipient": {
    "document": "47739506842",
    "documentType": "CPF",
    "email": "teste.souza@clear.sale",
    "phone": {
      "countryCode": 55,
      "areaCode": 51,
      "number": 981710000
    },
    "BankAccountData": {
            "bankNumber": 123,
            "agencyNumber": 3,
            "accountNumber": 4621,
            "accountLastNumber": 5,
            "accountType": 1
    },
    "zipCode": "90660130",
    "ipDevice": "192.168.18.8"
  },
  "sender": {
    "document": "04518345851",
    "documentType": "CPF",
    "email": "teste@clear.sale",
    "phone": {
      "countryCode": 55,
      "areaCode": 51,
      "number": 995756363
    },
    "BankAccountData": {
            "bankNumber": 123,
            "agencyNumber": 3,
            "accountNumber": 4621,
            "accountLastNumber": 5,
            "accountType": 1
     },
    "zipCode": "90660120",
    "ipDevice": "192.168.200.68",
  },
   "key": {
      "value": "47739506842",
      "type": "CPF",
      "creationDateKey": "2023-08-29T19:20:50.197Z",
      "creationDateAccount": "2023-08-29T19:20:50.197Z"
    },
  "currency": "BRL",
  "amount": 200,
  "referenceDate": "2023-10-01T09:00:00-03:00",
  "statistics": {
    "lastUpdated": "2023-08-29T19:20:50.197Z",
    "counters": [
      {
        "type": "Confirmed_Frauds",
        "by": "key",
        "d3": 3,
        "d30": 15,
        "m6": 30
      }
    ]
  }
}

Parâmetros

Nome Valor Tipo Obrigatório
cashType 1 Enum Sim
operationType 1 Enum Sim
recipient [object Object] String Sim
sender [object Object] String Sim
currency BRL String Não
amount 110.55 Number Não
referenceDate 2023-10-01T09:00:00-03:00 Datetime Sim
key [object Object] Object Opcional
statistics [object Object] Object Opcional
Recipient / Sender
Nome Valor Tipo Obrigatório
document 73417176026 String Sim
documentType CPF String Sim
email teste@teste.com String Não
phone [object Object] Object Não
bankAccountData [object Object] Object Não
zipCode 90660101 String Não
ipdevice 192.168.18.8 String Não
Key
Nome Valor Tipo Obrigatório
value 10770753000130 String Sim
type CNPJ String Sim
creationDateKey 2019-11-18T03:00:00+00:00 String Não
creationDateAccount 2019-11-18T03:00:00+00:00 String Não
Phone
Nome Valor Tipo Obrigatório
countryCode 55 Integer Sim
areaCode 51 Integer Sim
number 999999999 Integer Sim
BankAccountData
Nome Valor Tipo Obrigatório
bankNumber 123 Integer Sim
agencyNumber 4 Integer Sim
accountNumber 56789 Integer Sim
accountLastNumber 1 Integer Sim
accountType 1 Integer Sim
Statistics
Nome Valor Tipo Obrigatório
lastUpdated 2021-12-28T14:49:56.9115638+00:00 String Não
counters [Array] String Opcional
counters[0].FraudEventCounterDto.type CONFIRMED_FRAUDS String Sim
counters[0].FraudEventCounterDto.by KEY String Sim
counters[0].FraudEventCounterDto.d3 3 Integer Não
counters[0].FraudEventCounterDto.d30 4 Integer Não
counters[0].FraudEventCounterDto.m6 5 Integer Não
OperationType
Nome Valor Tipo Obrigatório
1 Pix
2 Ted
3 Recarga de Celular
CashType
Nome Valor Tipo Obrigatório
1 In
2 Out
AccountType
Nome Valor Tipo Obrigatório
1 CACC Conta Corrente
2 SLRY Conta Salário
3 SVGS Conta Poupança
4 TRAN Conta de Pagamento

Antifraud - Get - Retorna informação da análise de transações

Este endpoint está disponível na API para seguinte rota "v1/analysis/antifraud/{id}". Tem a finalidade de buscar o resultado de uma análise feita através do ID de uma análise já feita anteriormente.

Importância da Variável Resposta

Na API FeedBackFraud é enviado a variável resposta com relação a fraude encontrada podendo ter os status: suspeita, confirmada e cancelada.

O envio da variável resposta confirmada é muito importante pois:

  • Permite fazer a calibração do modelo: o modelo aprende as características e comportamentos do fraudador para poder identificá-lo no futuro.
  • Personalização do modelo: conhecendo a Variável Resposta, identificamos o fraudador que está atacando VOCÊ.
  • Incrementa o motor de decisão: conhecendo a Variável Resposta, te ajudamos a decidir: aprovar ou reprovar.