Criação de fraude suspeita

Requisitos de autenticação:

• Endpoints regulares usam OAuth2 autenticação com URL base: https://api.us.prd.caf.io
• Para maior segurança, alguns endpoints também podem suportar mTLS autenticação com URL base: https://mtls.us.prd.caf.io
• Para informações sobre a implementação de 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

https://api.us.prd.caf.io/v1/rs6https://mtls.us.prd.caf.io/v1/rs6https://api.us.stg.caf.io/v1/rs6https://mtls.us.stg.caf.io/v1/rs6

/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

bearerAuth

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

application/json

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.

400

Suspected fraud creation failed due to a bad request.

application/json

401

Unauthorized.

application/json

422

Suspected fraud creation failed, but the request was processed by the API, just not by the peer.

application/json

500

Suspected fraud creation failed due to an unexpected error in the API.

application/json

503

Suspected fraud creation failed due to an unexpected error in the Peer.

application/json

post/suspected-fraud

HTTPcURLJavaScriptPython

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

{
  "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-08-08T19:26:04.156Z",
    "local": "text",
    "canal": 1,
    "atividade_relacionada": 1,
    "classificacao": 1,
    "motivo": "text",
    "valor_transacao": 1,
    "valor_contrato": 1,
    "dispositivo": {
      "identificacao": "text",
      "ip": "0.0.0.0"
    },
    "envolvimento_reclamante": 1,
    "modalidade_fraude": 1
  }
}

{
  "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 requisição de exemplo, uma ocorrência de fraude suspeita é composta pelas seguintes propriedades:

• instituicao_responsavel: é um obrigatório campo e é representado por esquema do objeto da instituição responsável;
• informacoes_bancarias_destino: é um condicional campo e é representado por esquema do objeto da conta bancária de destino;
• informacao_executor: é um condicional** campo e é representado por esquema do objeto das informações do fraudador;
• informacao_reclamante: é um condicional** campo e é representado por esquema do objeto das informações do reclamante;
• registro: é um obrigatório campo e é representado por esquema do objeto da ocorrência.

** 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. É um objeto obrigatório.

Campo	Descrição	Obrigatoriedade do campo	Tipo de dado	Opções	Exemplos
cnpj_origem	CNPJ da instituição financeira que envia a evidência de fraude.	Obrigatório	string	-	"52337497000131"
razao_social_origem	Razão social da entidade registrada, a instituição financeira que envia 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. É 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	Obrigatoriedade 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 - CV Conta de depósito à vista (conta corrente) 2 - CP Conta de depósito em poupança (conta poupança) 3 - PP Conta de pagamento pré-paga	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	esquema	-
conta.titular.nome_completo_razao_social	Nome completo do titular da conta de destino.	Opcional	string	-	"Maria Silva"
conta.titular.nome_fantasia	Nome fantasia 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	esquema	-
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 da 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	-	"[email protected]"
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 de Informações do Fraudador: informacao_executor

Este objeto representa as informações do fraudador, quando disponíveis. É um objeto condicional, se o informacao_reclamante objeto não foi fornecido, o informacao_executor objeto é obrigatório.

Campo	Descrição	Obrigatoriedade do campo	Tipo de dado	Opções	Exemplos
nome	O nome completo ou a razão social do fraudador.	Obrigatório	string	-	"João Silva"
documento	O documento de identificação do fraudador.	Obrigatório	objeto	esquema	-
razao_social	Razão social, 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	esquema	-

Objeto de Informações do Reclamante: informacao_reclamante

Este objeto representa as informações do reclamante. É um objeto condicional, se o informacao_executor objeto não foi fornecido, o informacao_reclamante objeto é obrigatório.

Campo	Descrição	Obrigatoriedade do campo	Tipo de dado	Opções	Exemplos
documento	O documento de identificação do reclamante.	Obrigatório	objeto	esquema	-
documento_representante_legal	Documentos de identificação dos representantes legais do reclamante, quando aplicável.	Opcional	array	esquema	-

Objeto da Ocorrência: registro

Este objeto descreve os dados gerais da ocorrência. É um objeto obrigatório.

Campo	Descrição	Obrigatoriedade do campo	Tipo de dado	Opções	Exemplos
data_hora	Carimbo de data/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 na mesma instituição 5 - Transferência Eletrônica Disponível (TED) 6 - Transações de pagamento com cheques 7 - Transações de pagamento instantâneo (Pix) 8 - Transferências por Documento de Ordem de Crédito (DOC) 9 - Boletos 10 - Saques em dinheiro 99 - Outros	5
classificacao	Classificação da ocorrência.	Obrigatório	inteiro	1 - Fraude confirmada 2 - Fraude suspeita	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 ou 10	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 utilizado 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 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	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.data_hora é maior que 10 de março de 2025	inteiro	1 - Fraude própria 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 adulterados 11 - Fraude em benefícios 12 - Sequestro ou extorsão 98 - Inconclusivo 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"

Relação Modalidade de Fraude <> Atividade Relacionada

A 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.

modalidade_fraude	atividade_relacionada
1	Todas
2	Todas
3	Todas
4	Todas
5	2, 3, 4, 5, 6, 7, 8, 9 ou 10
6	Todas
7	2, 3, 4, 5, 6, 7, 8 ou 9
8	2, 3, 4, 5, 6, 7, 8 ou 9
9	Todas
10	9
11	Todas
12	Todas
98	Todas
99	Todas

Objeto de Documento

Este objeto representa um documento de identificação; pode ser de pessoa física ou jurídica. Esta representação do objeto é usada por: Objeto do Reclamante, Objeto do Fraudador e Objeto da Conta Bancária de Destino.

Campo	Descrição	Obrigatoriedade do campo	Tipo de dado	Opções	Exemplos
tipo	Indica se é 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 pessoa jurídica ("2"), deve conter o CNPJ completo. Atributo numérico, sem zeros à esquerda.	Obrigatório	string	-	"81321273070"