Pular para o conteúdo principal
Endpoint responsável por consultar informações de uma conta bancária com base no documento de identificação do correntista.
Por meio deste endpoint, o parceiro pode consultar um determinado documento, obterá através do integrador, o retorno de todas as contas vinculadas ao documento consultado sob o domínio da integração.

Autorizações

Authorization
string
header
obrigatório

Copie 'Bearer ' + token

Parâmetros de consulta

DocumentoFederal
string

CPF ou CNPJ do correntista para consulta.*

Observações:

  • O CPF ou CNPJ do correntista para consulta pode ter no máximo 14 caracteres.
  • Informar apenas os números do documento sem os caracteres de formatação (exemplo: ponto, traço, barra, etc.).

Resposta

Success

sucesso
boolean
mensagem
string | null
dtConsulta
string<date-time>
tipoPessoa
enum<integer>
Opções disponíveis:
1,
2
documentoFederal
string | null
contas
object[] | null