{
  "sucesso": true,
  "mensagem": "<string>",
  "dtConsulta": "2023-11-07T05:31:56Z",
  "tipoPessoa": 1,
  "documentoFederal": "<string>",
  "contas": [
    {
      "agencia": "<string>",
      "agenciaDigito": "<string>",
      "conta": "<string>",
      "contaDigito": "<string>",
      "contaPgto": "<string>",
      "tipoConta": 1,
      "modeloConta": 1,
      "situacao": 1,
      "parceiro": "<string>",
      "documentoFederal": "<string>"
    }
  ]
}
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.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Query Parameters

​
DocumentoFederal
string

CPF ou CNPJ para consulta.

Response

200 - application/json

Success

​
sucesso
boolean

Indica se a operação foi realizada com sucesso.

​
mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

​
dtConsulta
string<date-time>
​
tipoPessoa
enum<integer>

1 = PF; 2 = PJ

Available options:
1,
2
​
documentoFederal
string | null
​
contas
object[] | null