API - Antifraude Chave PIX - CMSW

/api/AntifraudePix

💡 O endpoint /api/AntifraudePix permite verificar o risco de fraude associado a uma chave PIX, analisando a probabilidade de titularidade e identificando possíveis contas laranjas. Este serviço é essencial para prevenção de fraudes e análise de risco em transações PIX.

Introdução

A API Antifraude Chave PIX - CMSW oferece análise de risco para transações PIX, possibilitando:

• Verificação da titularidade da chave PIX;
• Análise de risco de fraude;
• Identificação de possíveis contas laranjas;
• Validação do status da chave PIX.

Essa API é ideal para onboarding de clientes e fornecedores e análise de risco/crédito.

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br

Endpoint

GET /api/AntifraudePix

Esse endpoint retorna informações detalhadas sobre o risco associado a uma chave PIX.

Regras

1. Os parâmetros DOCUMENTO e CHAVE são obrigatórios.
2. O parâmetro TIPO deve ser enviado junto com a requisição.
3. Esta consulta não possui comprovante.

Autenticação

A autenticação é feita utilizando um TOKEN. Sem um token válido, o acesso será negado (401).

Regras de Autenticação

1. O TOKEN deve ser incluído como parâmetro obrigatório.
2. Caso o token seja inválido ou expirado, entre em contato pelo e-mail: suporte@directd.com.br.

Campos da API

Dados Retornados

• Chave PIX: Chave PIX consultada
• Documento: CPF/CNPJ associado à chave
• Nome Entidade: Nome do titular da chave
• Tipo: Tipo da chave PIX
• Status: Status atual da chave
• Probabilidade de Titularidade: Indicador de probabilidade de titularidade real
• Risco de Fraude: Nível de risco de fraude associado
• Risco de Laranja: Probabilidade de ser uma conta laranja

Parâmetros

Exemplo de Requisição

Usando cURL

curl -X 'GET' \
  'https://apiv3.directd.com.br/api/AntifraudePix?DOCUMENTO=12345678901&CHAVE=exemplo@email.com&TIPO=EMAIL&TOKEN=68ADA2C3-8016-47DA-ADE6-13AE239308FE' \
  -H 'accept: application/json'

Respostas

Sucesso (200)

A consulta foi realizada com sucesso e retorna os dados da análise antifraude.

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Antifraude Chave PIX - CMSW",
    "consultaUid": "direct-123456",
    "chave": "exemplo@email.com",
    "mensagem": "Consulta realizada com sucesso.",
    "resultado": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 150
  },
  "retorno": {
    "chavePix": "exemplo@email.com",
    "documento": "12345678901",
    "nomeEntidade": "João da Silva",
    "tipo": "EMAIL",
    "status": "ATIVA",
    "probabilidadeTitularidade": "ALTA",
    "riscoFraude": "BAIXO",
    "riscoLaranja": "BAIXO"
  }
}

Erros Comuns

Notas Importantes

• Todos os parâmetros obrigatórios (DOCUMENTO, CHAVE e TIPO) devem ser enviados em cada consulta.
• Esta consulta não gera comprovante em PDF.
• O valor por consulta é de R$ 1,44.
• Para dúvidas ou suporte, entre em contato pelo e-mail: suporte@directd.com.br.