Batches Search (CSV)

Página dedicada para CSVs envolvendo consulta em Lote (Batches Search)

Batches Search – Arquivo CSV - Requisição

💡

Os dados do arquivo devem ser separados por ponto e vírgula ";"

CampoTipoTamanhoDescriçãoObrigatoriedade
cpf Número 11 CPF a ser consultado. R (Recomendável) 
cnpj Número 14 CNPJ a ser consultado N (Não) 
email Texto 200 E-mail a ser consultado N (Não) 
phoneCountryCodeNúmero2DDI a ser consultadoN (Não)
phoneAreaCode Número DDD a ser consultado N (Não) 
phoneNumber Texto Número do telefone a ser consultado N (Não) 
relatedActivity Número Somente informativo. Atividade relacionada a transação que originou a consulta. Consultar a tabela de atividades relacionadas.R (Recomendável) 
transactionValue Número Somente informativo. Valor referente a transação que originou a consulta R (Recomendável)

Por mais que nenhum dado cadastral seja obrigatório, pelo menos um dos dados cadastrais acima devem ser preenchido, caso contrário, não será possível consultar.

👍

Batches Search – Retorno 200

CampoTipoTamanhoDescrição
id alfanumérico 24 Id gerado para o arquivo enviado 
fileName alfanumérico Nome do arquivo enviado 
status alfanumérico 20 Status do arquivo após ser enviado 
createdAt datetime Data de criação do arquivo 
totalRows numérico Número total de linhas do arquivo 
validRows numérico Número de linhas válidos do arquivo 
errorRows numérico Número de linhas com erro após a validação

Batches Search – Arquivo CSV – Resposta

Campo Tipo Tamanho Descrição

id

alfanumérico 

25 

Id da consulta 

institutionCnpj

numérico

14

Cnpj da instituição registrante

institutionCompanyName

alfanumérico

Nome da empresa da instituição registrante

datasource

numérico 

Banco de dados de origem do indício de fraude:

0 - Resolução 6 
1 – Interoperabilidade
2 – Chargeback 

evidenceType

numérico 

Distinção se houve indício de ocorrência ou de tentativa de fraude:

1 - Ocorrência
2 - Tentativa 

fraudModality

numérico 

Modalidade da fraude. Consultar a tabela de modalidade de fraudes.

relatedActivity

numérico 

Atividade relacionada a transação que ocorreu o indício de fraude. Consultar a tabela de referência. 

transactionValue

numérico 

Valor da transação em que ocorreu o indício 

contractValue

numérico

Valor do contrato em que ocorreu o indício

description

alfanumérico 

200 

Descrição da causa ou procedimento que ensejou o indício 

connection

numérico

role

numérico 

Papel exercido pelo documento no indício de fraude:

0 – Reporter
1 – Executor
2 - ToAccount 

documentType

alfanumérico 

Indica o tipo de dado consultado:
Cpf
Cnpj
Email
Phone

documentValue

alfanumérico 

Valor do documento consultado 

fullName 

alfanumérico 

100 

Nome completo do documento ou Razão Social da empresa 

tradeName 

alfanumérico 

100 

Em caso de CNPJ, Nome Fantasia da empresa 

cpfLegalRepresentatives 

alfanumérico 

Em caso de CNPJ, CPF dos representantes legais da empresa (separado por vírgula) 

reporterInvolvement 

numérico 

Indicação sobre o envolvimento do reclamante no indício de fraude:

1 – Sim
2 - Não

toAccountInstitutionCode 

numérico 

Código da Instituição Financeira da conta (ISPB)

toAccountAccountType 

alfanumérico 

Tipo da Conta: 

CV - Conta depósito à vista
CP - Conta de depósito poupança
PP - Conta de pagamento pré-paga

toAccountAgencyCode 

alfanumérico 

10

Código da agência bancária 

toAccountAccountNumber 

alfanumérico 

20 

Número da conta 

toAccountPixType

Estará disponível em produção a partir do dia 10/03/2025

alfanumérico

2

Identificação do tipo da chave PIX da conta destinatária.

Conferir Tabela de Domínios

toAccountPixKey

Estará disponível em produção a partir do dia 10/03/2025

alfanumérico

50

Valor da chave PIX da conta destinatária do indício de fraude

Validação a depender do Tipo Chave PIX.

toAccountLinhaBoleto

Estará disponível em produção a partir do dia 10/03/2025

alfanumérico

60

Linha digitável do boleto que houve o indício de fraude relacionado a conta destinatária.

channel 

numérico 

Canal utilizado para execução: 

1 – Internet
2 – Celular
3 – Autoatendimento
4 – Rede Parceiros
5 - Mídias Sociais
6 - Interbancário
7 - Outros 

local 

alfanumérico 

100 

Local onde ocorreu o indício de fraude.
Sugestão de preenchimento: "Logradouro e CEP"

ipAddress 

numérico 

100 

Endereço de IP utilizado 

device 

alfanumérico 

30 

Dispositivo eletrônico utilizado 

eventDateTime 

datetime 

Data e hora da ocorrência do indício de fraude 

createdAt 

datetime 

Data e hora da criação da consulta