Pular para o conteúdo principal
GET
/
api
/
Conta
/
ConsultaContaPorDocumento
Endpoint responsável por consultar informações de uma conta bancária com base no documento de identificação do correntista.
curl --request GET \
  --url https://api.ext.dbs.moneyp.dev.br/api/Conta/ConsultaContaPorDocumento \
  --header 'Authorization: <api-key>'
{
  "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>",
      "tipoBloqueio": 0,
      "valorBloqueado": 123
    }
  ]
}
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 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.).

Response

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