For the complete documentation index, see llms.txt. This page is also available as Markdown.

Criação de fraude suspeita

Requisitos de autenticação:

  • Os endpoints regulares usam OAuth2 autenticação com a URL base: https://api.us.prd.caf.io

  • Para maior segurança, alguns endpoints também podem oferecer suporte a mTLS autenticação com a URL base: https://mtls.us.prd.caf.io

  • Para informações sobre como implementar mTLS, acesse Usando mTLS

Uma solicitação de criação de fraude suspeita insere uma fraude suspeita no banco de dados do seu par e esses dados ficam disponíveis para outros pares na rede.

Suspected Fraud Creation

post
/suspected-fraud

Inserts a suspected fraud into your peer's database and this data become available to other peers in the network.

Permission required: Create RS6

Autorizações
AuthorizationstringObrigatório

JWT Authorization header using the Bearer scheme.

Parâmetros de cabeçalho
AuthorizationstringObrigatório

Your access token. See more in the 'Authentication' topic of this section.

Example: Bearer YOUR_TOKEN
Corpo

Suspected fraud occurence, condenses all relevant information about a suspected fraud.

Respostas
200

Suspected fraud creation occurred successfully.

application/json
messagestringObrigatório

Human readable message informing about the operation.

fraudTokenstring · uuidObrigatório

Unique identifier of the suspected fraud.

post/suspected-fraud
POST /v1/rs6/suspected-fraud HTTP/1.1
Host: api.us.prd.caf.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 1176

{
  "instituicao_responsavel": {
    "cnpj_origem": "text",
    "razao_social_origem": "text"
  },
  "informacoes_bancarias_destino": {
    "codigo_instituicao": 1,
    "ispb": "text",
    "agencia": "text",
    "conta": {
      "numero": "text",
      "tipo": 1,
      "titular": {
        "documento": {
          "tipo": 1,
          "numero": "text"
        },
        "nome_completo_razao_social": "text",
        "nome_fantasia": "text"
      },
      "documento_representante_legal": [
        {
          "tipo": 1,
          "numero": "text"
        }
      ]
    },
    "chave_pix": {
      "tipo": 1,
      "valor": "text"
    },
    "linha_digitavel_boleto": "text"
  },
  "informacao_executor": {
    "nome": "text",
    "razao_social": "text",
    "documento": {
      "tipo": 1,
      "numero": "text"
    },
    "documento_representante_legal": [
      {
        "tipo": 1,
        "numero": "text"
      }
    ]
  },
  "informacao_reclamante": {
    "documento": {
      "tipo": 1,
      "numero": "text"
    },
    "documento_representante_legal": [
      {
        "tipo": 1,
        "numero": "text"
      }
    ]
  },
  "registro": {
    "data_hora": "2026-01-01T00:00:00.000Z",
    "local": "text",
    "canal": 1,
    "atividade_relacionada": 1,
    "classificacao": 1,
    "classificacao_irregularidade": 1,
    "operadora_aposta_dominio": "example.com",
    "motivo": "text",
    "valor_transacao": 1,
    "valor_contrato": 1,
    "dispositivo": {
      "identificacao": "text",
      "ip": "0.0.0.0"
    },
    "envolvimento_reclamante": 1,
    "modalidade_fraude": 1,
    "ativo_virtual": {
      "tipo_operacao": 1,
      "moeda": "text",
      "quantidade": "text",
      "transacao_id": "text"
    }
  }
}
{
  "message": "text",
  "requestStatus": {
    "status": "SUCCESS",
    "token": "123e4567-e89b-12d3-a456-426614174000"
  },
  "fraudToken": "123e4567-e89b-12d3-a456-426614174000"
}

Modelo de dados da ocorrência

Conforme demonstrado na solicitação de exemplo, uma ocorrência de fraude suspeita é composta pelos seguintes atributos:

¹: Pelo menos um dos objetos, informacao_executor ou informacao_reclamante, deve estar presente.

Objeto da Instituição Responsável: instituicao_responsavel

Este objeto descreve a instituição financeira que está enviando a ocorrência. Trata-se de um objeto obrigatório.

Campo
Descrição
Requisito do Campo
Tipo de dado
Opções
Exemplos

cnpj_origem

CNPJ da instituição financeira que está enviando a evidência de fraude.

Obrigatório

string

-

"52337497000131"

razao_social_origem

Razão social da instituição financeira que está enviando a evidência de fraude.

Obrigatório

string

-

"Empresa XYZ Ltda."

Objeto da Conta Bancária de Destino: informacoes_bancarias_destino

Este objeto descreve as informações bancárias da conta de destino da ocorrência, quando aplicável. Trata-se de um objeto condicional: se registro.atividade_relacionada for igual a: 4, 5, 6, 7 ou 8, o informacoes_bancarias_destino objeto é obrigatório.

Campo
Descrição
Requisito do Campo
Tipo de dado
Opções
Exemplos

agencia

Código da agência bancária de destino. Deve ser composto pelo prefixo da agência e pelo dígito verificador sem separador/hífen.

Condicional Este campo é obrigatório quando chave_pix.tipo for igual a: 6

string

-

"0123"

codigo_instituicao

Obsoleto ISPB da instituição de destino.

Condicional Este objeto é obrigatório quando ispb não é fornecido

inteiro

-

00000000

ispb

ISPB da instituição de destino.

Condicional Este objeto é obrigatório quando codigo_instituicao não é fornecido

string

-

"00A0Z000"

conta

Detalhes da conta bancária de destino.

Condicional Este objeto é obrigatório quando registro.atividade_relacionada for igual a: 4, 5, 6, 7 ou 8; Ou quando chave_pix.tipo for igual a: 6

objeto

-

-

conta.numero

Número da conta bancária de destino. Deve ser composto pelo prefixo da conta e pelo dígito verificador sem separador/hífen.

Obrigatório

string

-

"1234567890"

conta.tipo

Tipo da conta bancária de destino.

Obrigatório

inteiro

1 - Conta de depósito à vista CV (conta corrente) 2 - Conta de depósito em poupança CP (conta poupança) 3 - Conta de pagamento pré-paga PP

1

conta.titular

Detalhes do titular da conta de destino.

Condicional Este campo é obrigatório quando registro.atividade_relacionada for igual a: 4, 5, 6, 7 ou 8

objeto

-

-

conta.titular.documento

Documento de identificação do titular da conta de destino.

Opcional

objeto

-

conta.titular.nome_completo_razao_social

Nome completo do titular da conta de destino.

Opcional

string

-

"Maria Silva"

conta.titular.nome_fantasia

Nome empresarial do titular da conta de destino, quando aplicável.

Opcional

string

-

"Empresa XYZ"

conta.documento_representante_legal

Documentos de identificação dos representantes legais do titular da conta, quando aplicável.

Opcional

array

-

chave_pix

Chave PIX da conta de destino suspeita de fraude.

Condicional Este objeto é obrigatório quando registro.atividade_relacionada for igual a: 7

objeto

-

-

chave_pix.tipo

Tipo de chave PIX.

Obrigatório

inteiro

1 - CPF 2 - CNPJ 3 - Número de telefone 4 - E-mail 5 - Aleatória 6 - Conta bancária

4

chave_pix.valor

Valor da chave PIX.

Condicional Este campo é obrigatório quando chave_pix.tipo não é igual a: 6

string

-

linha_digitavel_boleto

Linha digitável do boleto vinculada à suspeita de fraude na conta de destino.

Condicional Este campo é obrigatório quando registro.atividade_relacionada for igual a: 9

string

-

"00190500950448160698093503143373700000001000"

Objeto das Informações do Fraudador: informacao_executor

Este objeto representa as informações do fraudador, quando disponíveis. Trata-se de um objeto condicional: se o informacao_reclamante objeto não for fornecido, o informacao_executor objeto é obrigatório. Após GMUD Operadores de Apostas Não Autorizados | BCB 569, este objeto é obrigatório quando registro.classificacao_irregularidade for igual a: 1.

Campo
Descrição
Requisito do Campo
Tipo de dado
Opções
Exemplos

nome

Nome completo ou razão social do fraudador.

Obrigatório

string

-

"João Silva"

documento

Documento de identificação do fraudador.

Obrigatório

objeto

-

razao_social

Razão social do fraudador, quando aplicável.

Opcional

string

-

"Empresa XYZ Ltda."

documento_representante_legal

Documentos de identificação dos representantes legais do fraudador, quando aplicável.

Opcional

array

-

Objeto das Informações do Reclamante: informacao_reclamante

Este objeto representa as informações do reclamante. Trata-se de um objeto condicional: se o informacao_executor objeto não for fornecido, o informacao_reclamante objeto é obrigatório.

Campo
Descrição
Requisito do Campo
Tipo de dado
Opções
Exemplos

documento

Documento de identificação do reclamante.

Obrigatório

objeto

-

documento_representante_legal

Documentos de identificação dos representantes legais do reclamante, quando aplicável.

Opcional

array

-

Objeto da Ocorrência: registro

Este objeto descreve os dados gerais da ocorrência. Trata-se de um objeto obrigatório.

Campo
Descrição
Requisito do Campo
Tipo de dado
Opções
Exemplos

data_hora

Carimbo de data e hora no formato ISO "YYYY:MM::DDThh:mm:ss.sTZD" que indica a ocorrência da tentativa de fraude suspeita.

Obrigatório

string

-

"2024-04-03T12:00:00Z"

atividade_relacionada

Atividade relacionada à ocorrência ou tentativa de fraude, conforme a lista.

Obrigatório

inteiro

1 - Abertura de conta de depósito ou conta de pagamento 2 - Manutenção de conta de depósito ou conta de pagamento 3 - Contratação de operação de crédito 4 - Transferências entre contas da mesma instituição 5 - Transferência Eletrônica Disponível (TED) 6 - Transações de pagamento usando cheques 7 - Transações de pagamento instantâneo (Pix) 8 - Transferências por Documento de Crédito (DOC) 9 - Boletos 10 - Saques de dinheiro em espécie 11 - Prestação de serviços de ativos virtuais

5

classificacao

Classificação da ocorrência.

Obrigatório

inteiro

1 - Fraude Confirmada 2 - Fraude Suspeita 3 - Irregularidade

1

classificacao_irregularidade

Classificação do tipo de irregularidade.

Condicional Este campo é obrigatório e exclusivo quando registro.classificacao for igual a: 3

inteiro

1 - Atividade como operador de apostas não autorizado

1

envolvimento_reclamante

Indica se houve envolvimento do cliente na ocorrência ou tentativa de fraude. O envolvimento do cliente é independente de ter sido por terceiros ou não.

Obrigatório

inteiro

1 - Sim 2 - Não

1

valor_transacao

Se a indicação de fraude for uma operação de pagamento, informe o valor da transação.

Condicional Este campo é obrigatório quando registro.atividade_relacionada for igual a: 4, 5, 6, 7, 8, 9, 10 ou 11

número

-

1000.00

valor_contrato

Se a indicação de fraude for uma operação de crédito, informe o valor do contrato.

Condicional Este campo é obrigatório quando registro.atividade_relacionada for igual a: 3

número

-

5000.00

canal

Forma de interação ou canal usado para a execução da ocorrência ou tentativa de fraude.

Opcional

inteiro

1 - Internet 2 - Mobile 3 - Autoatendimento 4 - Rede de parceiros 5 - Redes sociais 6 - Interbancário 7 - Outros

3

local

Local onde a atividade foi realizada, quando aplicável.

Opcional

string

-

"Agência X"

motivo

Descrição da causa ou do procedimento que levou à ocorrência ou tentativa de fraude, quando aplicável.

Condicional Este campo é obrigatório quando registro.modalidade_fraude for igual a: 98 ou 99; ou registro.classificacao for igual a: 3

string

-

"Cobrança indevida"

modalidade_fraude

Modalidade relacionada à ocorrência ou tentativa de fraude, conforme a lista.

Obrigatório Este campo é obrigatório quando registro.classificacao não é igual a: 3

inteiro

1 - Autofraude 2 - Conta laranja 3 - Roubo de identidade (ITO) 4 - Identidade sintética 5 - Tomada de conta - ATO 6 - Fraude amigável/familiar/de segunda parte 7 - Fraude do comprador 8 - Fraude do vendedor 9 - Troca de SIM 10 - Fraude com boletos alterados 11 - Fraude de benefícios 12 - Sequestro ou extorsão 98 - Inconclusiva 99 - Modalidade não listada

5

dispositivo

Informações sobre o dispositivo utilizado.

Opcional

objeto

-

-

dispositivo.identificacao

Identificação do dispositivo usado na execução da ocorrência ou tentativa de fraude.

Opcional

string

-

"ID-1234"

dispositivo.ip

Descrição das informações referentes ao endereço de Protocolo de Internet (IP) do dispositivo usado na ocorrência ou tentativa de fraude, quando aplicável.

Opcional

string

-

"192.168.0.1"

operadora_aposta_dominio

Domínio/URL relacionado ao operador de apostas irregular

Condicional Este campo é opcional e exclusivo quando registro.classificacao_irregularidade for igual a: 1

string

-

"irregular-bet.com"

ativo_virtual

Informações sobre o ativo virtual.

Condicional Este campo é obrigatório quando registro.atividade_relacionada for igual a: 11

objeto

-

-

ativo_virtual.tipo_operacao

Classifica a natureza da operação informada.

Obrigatório

inteiro

1 - Compra 2 - Venda 3 - Transferência / saque para carteira externa 4 - Recebimento de carteira externa 5 - Transferência interna entre clientes 6 - Troca entre ativos virtuais 7 - Depósito 99 - Outro

1

ativo_virtual.moeda

Símbolo da moeda do ativo virtual movimentado.

Obrigatório

string

Expressão regular: ^[A-Z0-9]{1,10}$ Também deve corresponder a um símbolo canônico de ativo virtual (por exemplo, BTC, ETH, LTC, DOGE).

"BTC"

ativo_virtual.quantidade

Quantidade do ativo virtual associada à indicação de fraude.

Obrigatório

string

Expressão regular: ^\d+[.,]\d+$

"0,00000001"

ativo_virtual.transacao_id

Identificador único da transação (hash).

Opcional

string

-

"1843b174549cfbe3f6ba979df44c5b1b4632876b6aa99b1a51057c79219b2fd8"

Relação entre Modalidade de Fraude <> Atividade Relacionada

O registro.modalidade_fraude tem uma relação dependente com registro.atividade_relacionada. As relações na tabela abaixo são permitidas; qualquer relação fora da tabela é inválida. Além disso registro.modalidade_fraude é bloqueado quando registro.classificacao é igual a: 3.

atividade_relacionada

modalidade_fraude

1

1, 2, 3, 4, 6, 9, 11, 12, 98, 99

2

1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 98, 99

3

1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 98, 99

4

1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 98, 99

5

1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 98, 99

6

1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 98, 99

7

1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 98, 99

8

1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 98, 99

9

Todos

10

1, 2, 3, 4, 5, 6, 9, 11, 12, 98, 99

11

1, 2, 3, 4, 5, 6, 7, 8, 12, 98, 99

Outra relação presente no esquema foi introduzida por GMUD Operadores de Apostas Não Autorizados | BCB 569, limitando os valores disponíveis de registro.atividade_relacionada quando registro.classificacao_irregularidade é igual a: 1. Os valores disponíveis são: 4, 5, 6, 7, 8, 9 e 10.

Objeto do Documento

Este objeto representa um documento de identificação; ele pode ser o documento de uma pessoa física ou jurídica. Essa representação de objeto é usada pelo Objeto das Informações do Reclamante, Objeto das Informações do Fraudador, e Objeto da Conta Bancária de Destino.

Campo
Descrição
Requisito do Campo
Tipo de dado
Opções
Exemplos

tipo

Indica se é uma pessoa física ou jurídica.

Obrigatório

inteiro

1 - CPF 2 - CNPJ

1

numero

Se o tipo de documento for "1", este atributo deve conter o CPF. Se for uma pessoa jurídica ("2"), ele deve conter o CNPJ completo. Atributo numérico, sem zeros à esquerda.

Obrigatório

string

-

"81321273070"

Atualizado