> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# 40 - Account Consult by Document

> <p>Scopes:</p>
<b>api.ext api.conta.consultaPorDocumento</b>

Through this endpoint, the partner can consult a specific document and will receive, through the integrator, the return of all accounts linked to the consulted document under the integration domain.


## OpenAPI

````yaml get /api/Conta/ConsultaContaPorDocumento
openapi: 3.0.1
info:
  title: BMPSPBExt
  description: '<p><strong>Build Number: </strong>#0.0</p>'
  version: v1
servers:
  - url: https://api.ext.dbs.moneyp.dev.br/
    description: Localhost
security:
  - Bearer: []
paths:
  /api/Conta/ConsultaContaPorDocumento:
    get:
      tags:
        - Conta
      summary: >-
        Endpoint responsável por consultar informações de uma conta bancária com
        base no documento de identificação do correntista.
      description: "<p>Scopes:</p>\r\n<b>api.ext api.conta.consultaPorDocumento</b>"
      parameters:
        - name: DocumentoFederal
          in: query
          description: >-
            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.).
          schema:
            type: string
            description: >-
              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.).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.Conta.ConsultaContaPorDocumentoResponse
        '400':
          description: Erro de negócio
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
        '500':
          description: Erro interno do servidor
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
components:
  schemas:
    BMPSPB.Domain.Messaging.API.Externa.Conta.ConsultaContaPorDocumentoResponse:
      type: object
      properties:
        sucesso:
          type: boolean
        mensagem:
          type: string
          nullable: true
        dtConsulta:
          type: string
          format: date-time
        tipoPessoa:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoPessoa'
        documentoFederal:
          type: string
          nullable: true
        contas:
          type: array
          items:
            $ref: >-
              #/components/schemas/BMPSPB.Domain.Messaging.API.Shared.Conta.ContaCompletaDto
          nullable: true
      additionalProperties: false
    BMPSPB.Infra.Enums.TipoPessoa:
      enum:
        - 1
        - 2
      type: integer
      description: ''
      format: int32
    BMPSPB.Domain.Messaging.API.Shared.Conta.ContaCompletaDto:
      type: object
      properties:
        agencia:
          type: string
          description: |-
            Número da agência bancária.*

            Observações:
            - O número da agência pode ter no máximo 4 caracteres.
          nullable: true
        agenciaDigito:
          type: string
          description: >-
            Dígito verificador da agência bancária.


            Observações:

            - O dígito verificador da agência bancária pode ter no máximo 1
            caracter.
          nullable: true
        conta:
          type: string
          description: >-
            Número da conta bancária.


            Observações:

            - O número da conta bancária pode ter no máximo 12 caracteres.

            - Para que seja possível localizar a conta, é necessário informar o
            'número da conta com dígito' (```contaPgto```) ou o 'número da
            conta' (```conta```) e o 'dígito verificador' (```contaDigito```).

            - Caso o 'número da conta com dígito' (```contaPgto```) seja
            informado, não é necessário preencher os campos 'número da conta'
            (```conta```) e 'dígito verificador' (```contaDigito```).

            - Caso nenhum dos campos referentes ao número da conta seja
            informado, ocorrerá erro na requisição devido à falta de informação
            vital.
          nullable: true
        contaDigito:
          type: string
          description: >-
            Dígito verificador do número da conta bancária.


            Observações:

            - O dígito verificador do número da conta bancária pode ter no
            máximo 1 caracter.
          nullable: true
        contaPgto:
          type: string
          description: >-
            Número da conta bancária seguido do dígito verificador.


            Observações:

            - O número da conta seguido do dígito verificador pode ter no máximo
            20 caracteres.
          nullable: true
        tipoConta:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoConta'
          description: |-
            Tipo da conta.*

            Valores:
            1 - Corrente
            2 - Poupanca
            3 - Pagamento
            4 - Salario
          nullable: true
        modeloConta:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.ModeloConta'
          description: |-
            Modelo da conta.*

            Valores:
            1 - Movimento
            2 - Escrow
            3 - Vinculada
          nullable: true
        situacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.SituacaoConta'
          description: |-
            Situacao conta.*

            Valores:
            1 - Ativa
            2 - Inativa
            3 - Fechada
            4 - Cadastrado
          nullable: true
        parceiro:
          type: string
          description: Nome do parceiro.
          nullable: true
        documentoFederal:
          type: string
          description: Documento federal do parceiro.
          nullable: true
        tipoBloqueio:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoBloqueioConta'
          description: |-
            Tipo bloqueio conta.

            Valores:
            0 - Sem Bloqueio
            1 - Débito
            2 - Crédito
            3 - Débito e Crédito
          nullable: true
        valorBloqueado:
          type: number
          description: Valor de bloqueio.
          format: double
          nullable: true
      additionalProperties: false
    BMPSPB.Infra.Enums.TipoConta:
      enum:
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.ModeloConta:
      enum:
        - 1
        - 2
        - 3
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.SituacaoConta:
      enum:
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.TipoBloqueioConta:
      enum:
        - 0
        - 1
        - 2
        - 3
      type: integer
      description: ''
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Copie 'Bearer ' + token
      name: Authorization
      in: header

````