> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# API para obter conta bancária: identificadores, titulares e sincronização

> O endpoint Obter uma conta da Didit retorna uma conta com seus identificadores, titulares, atualidade da sincronização e cobertura do histórico.

O endpoint Obter uma conta da Didit retorna uma conta com seus identificadores, titulares, recência da sincronização e cobertura do histórico.
`sync.last_synced_at` indica quando a Didit buscou os dados pela última vez junto ao banco.
Os identificadores completos exigem a permissão de dados bancários na sua chave de API.
Consulte [Contas, saldos e transações](https://docs.didit.me/pt-br/core-technology/bank-verification/accounts-balances-transactions.md).


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/bank/accounts/{account_id}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, conexões, contas, saldos, transações, instituições e cobertura.
      Os dados bancários estão disponíveis para aplicações do sandbox. As
      chamadas de uma aplicação em produção respondem `404` até que o acesso em
      produção seja anunciado. Nada é cobrado no sandbox. Uma chamada feita com
      chave de API exige uma chave que tenha a permissão de dados bancários
      (`bank-data`): leitura para consultas e escrita para operações que alteram
      algo. A verificação de conta é a exceção: ela exige acesso de escrita a
      sessões, ou acesso total, e não a permissão de dados bancários.


      Os dados bancários não fazem parte do acesso total: uma chave com acesso
      total é recusada, e a chamada responde `403 bank_data_access_denied` até
      que você crie uma chave que tenha a permissão. Os dados brutos do banco
      (contas, saldos, transações e o feed de alterações) também recusam uma
      requisição sem chave de API.


      Toda recusa em `/v3/bank/`, exceto a da verificação de conta, tem o mesmo
      corpo JSON (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`). Um caminho que não é uma operação, um ID que não é um UUID
      ou um subrecurso desconhecido responde `404 not_found` para todos os
      métodos, e qualquer erro inesperado responde `500 internal_error` com um
      `request_id`. Quando os dados bancários não estão disponíveis, toda
      operação responde o `404` padrão da plataforma, exatamente como ocorre com
      uma rota desconhecida.
paths:
  /v3/bank/accounts/{account_id}/:
    get:
      tags:
        - Bank Data
      summary: Obter uma conta
      description: >-
        Retorna uma conta com identificadores completos, titulares, estado da
        sincronização e `history_coverage`, que indica o que o banco entregou do
        histórico solicitado. `sync.last_synced_at` é o momento em que os dados
        foram obtidos do banco, não o momento em que você os leu.


        Exige uma chave de API com a permissão Dados bancários (`bank-data`):
        leitura para esta operação. Uma chave com acesso total não inclui essa
        permissão: conceda-a explicitamente ao criar a chave, ou a chamada
        retornará `403 bank_data_access_denied`. Uma aplicação sandbox lê os
        dados do seu Test Bank apenas com a chave. Uma requisição sem chave de
        API (credenciais de cliente) é recusada para dados brutos com o mesmo
        `403`.
      operationId: getBankAccount
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: O ID da conta.
      responses:
        '200':
          description: A conta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankAccount'
              examples:
                Business account:
                  summary: Uma conta corrente empresarial na Espanha
                  value:
                    id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                    connection_id: 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                    name: Cuenta negocio
                    product: Cuenta corriente empresas
                    type: current
                    usage: business
                    currency: EUR
                    holder_name: EMPRESA DE EJEMPLO SL
                    holders:
                      - name: EMPRESA DE EJEMPLO SL
                        role: holder
                    identifiers:
                      iban: ES0000000000000000001332
                      bic: XXXXESBBXXX
                      account_number: null
                      sort_code: null
                      other: []
                    account_ref: ar_f3c1a85e9d27b640c8e1
                    account_ref_previous: null
                    status: open
                    scopes_granted:
                      - accounts
                      - balances
                      - transactions
                    sync:
                      last_synced_at: '2026-11-21T12:04:40Z'
                      status: ok
                      history_requested_from: '2025-11-21'
                      history_available_from: '2026-01-02'
                      pending_supported: true
                    history_coverage:
                      requested_from: '2025-11-21'
                      oldest_booking_date: '2026-01-02'
                      covered_ranges:
                        - from: '2026-01-02'
                          to: '2026-11-21'
                      missing_ranges:
                        - from: '2025-11-21'
                          to: '2026-01-01'
                      status: partial
                      extended_auth_used: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: O recurso não existe nesta aplicação e neste ambiente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Não encontrado
                  value:
                    code: not_found
                    message: The resource does not exist.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '409':
          description: >-
            A pessoa não compartilha mais esta conta (`access_removed`), ou a
            conexão foi excluída ou seus dados não são mais legíveis
            (`connection_not_active`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Access removed:
                  summary: Acesso removido
                  value:
                    code: access_removed
                    message: The person no longer shares this account.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '429':
          $ref: '#/components/responses/RateLimitedRead'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl
            'https://verification.didit.me/v3/bank/accounts/a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.get_account(
                "11111111-2222-3333-4444-555555555555",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.bank.getAccount("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.GetAccount(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.bank().getAccount("11111111-2222-3333-4444-555555555555");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $result =
            $didit->bank->getAccount('11111111-2222-3333-4444-555555555555');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.bank.get_account("11111111-2222-3333-4444-555555555555")

            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Bank.GetAccountAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankAccount:
      type: object
      description: Uma conta dentro de uma conexão.
      properties:
        id:
          type: string
          description: >-
            ID da conta. Pertence à conexão e nunca muda enquanto ela existir,
            inclusive nas renovações.
          format: uuid
        connection_id:
          type: string
          format: uuid
        name:
          type: string
          nullable: true
        product:
          type: string
          description: O nome do produto bancário.
          nullable: true
        type:
          type: string
          enum:
            - current
            - savings
            - card
            - loan
            - investment
            - other
        usage:
          type: string
          enum:
            - personal
            - business
            - unknown
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: Código de moeda ISO 4217.
        holder_name:
          type: string
          description: Nome do titular, quando o banco o compartilha.
          nullable: true
        holders:
          type: array
          items:
            $ref: '#/components/schemas/BankAccountHolder'
          description: >-
            Titulares que o banco compartilha. Para propriedade, são
            considerados apenas `holder` e `joint_holder`.
        identifiers:
          $ref: '#/components/schemas/BankAccountIdentifiers'
        account_ref:
          type: string
          description: >-
            Identifica a mesma conta bancária entre conexões de uma mesma
            aplicação e ambiente: um hash com chave dos identificadores próprios
            do banco. `null` quando o banco não fornece um identificador
            confiável. Use-o para reconhecer uma conta bancária que você já
            conhece.
          nullable: true
        account_ref_previous:
          type: string
          description: >-
            O `account_ref` anterior, apenas para um alias verificado, como uma
            migração de banco.
          nullable: true
        status:
          type: string
          enum:
            - open
            - closed
            - access_removed
          description: >-
            `access_removed`: a pessoa removeu a conta do consentimento. Ela não
            é mais sincronizada.
        scopes_granted:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
        sync:
          $ref: '#/components/schemas/BankAccountSync'
        history_coverage:
          $ref: '#/components/schemas/BankHistoryCoverage'
      required:
        - id
        - connection_id
        - name
        - product
        - type
        - usage
        - currency
        - holder_name
        - holders
        - identifiers
        - account_ref
        - account_ref_previous
        - status
        - scopes_granted
        - sync
        - history_coverage
    BankDataError:
      type: object
      description: >-
        Corpo de erro de toda operação de Dados bancários. Todos os campos estão
        sempre presentes.
      properties:
        code:
          type: string
          enum:
            - ongoing_access_not_available
            - segment_not_available
            - window_not_available
            - history_window_ambiguous
            - redirect_url_not_registered
            - link_origin_not_allowed
            - bank_data_access_denied
            - connection_not_active
            - consent_expired
            - renewal_not_needed
            - renewal_window_expired
            - access_removed
            - refresh_limit_reached
            - cursor_expired
            - page_expired
            - invalid_cursor
            - page_token_mismatch
            - contract_rate_missing
            - insufficient_credits
            - invalid_request
            - not_found
            - internal_error
          description: >-
            Código de erro legível por máquina. Decida o fluxo com base neste
            valor, nunca em `message`.
        message:
          type: string
          description: >-
            Explicação em linguagem simples para o desenvolvedor. O texto pode
            mudar; não o processe.
        request_id:
          type: string
          description: >-
            Identificador desta requisição. Informe-o ao entrar em contato com o
            suporte.
        field:
          type: string
          description: >-
            O campo da requisição a ser corrigido, quando o erro se refere a um
            único campo. Caso contrário, `null`.
          nullable: true
        next_action:
          type: string
          enum:
            - retry_later
            - renew_connection
            - create_link
            - restart_from_cursor
            - restart_read
            - top_up_balance
            - enable_bank_data_access
            - contact_support
            - null
          description: >-
            O que fazer em seguida, para que um cliente possa agir sem
            adivinhar. `null` quando não há uma próxima etapa padrão.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Segundos a aguardar antes de tentar novamente. Definido em erros de
            limite de requisições e erros temporários; caso contrário, `null`.
          nullable: true
      required:
        - code
        - message
        - request_id
        - field
        - next_action
        - retry_after
      example:
        code: ongoing_access_not_available
        message: >-
          This bank cannot keep access open. Use access one_time or choose
          another bank.
        request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
        field: institution_id
        next_action: create_link
        retry_after: null
    BankAccountHolder:
      type: object
      properties:
        name:
          type: string
        role:
          type: string
          enum:
            - holder
            - joint_holder
            - representative
            - unknown
      required:
        - name
        - role
    BankAccountIdentifiers:
      type: object
      description: >-
        Identificadores completos, retornados a chamadores no servidor com a
        permissão de dados bancários.
      properties:
        iban:
          type: string
          description: IBAN completo, em letras maiúsculas e sem espaços.
          nullable: true
        bic:
          type: string
          nullable: true
        account_number:
          type: string
          description: Número da conta local, quando a conta não tiver IBAN.
          nullable: true
        sort_code:
          type: string
          description: Código do banco local, quando a conta não tiver IBAN.
          nullable: true
        other:
          type: array
          items:
            type: object
            properties:
              scheme:
                type: string
              value:
                type: string
            required:
              - scheme
              - value
          description: Qualquer outro identificador fornecido pelo banco.
      required:
        - iban
        - bic
        - account_number
        - sort_code
        - other
    BankAccountSync:
      type: object
      properties:
        last_synced_at:
          type: string
          description: Quando os dados da conta foram buscados pela última vez no banco.
          format: date-time
          nullable: true
        status:
          type: string
          enum:
            - pending
            - ok
            - failed
        history_requested_from:
          type: string
          format: date
          nullable: true
        history_available_from:
          type: string
          description: >-
            A data de lançamento mais antiga que o banco realmente entregou para
            esta conta.
          format: date
          nullable: true
        pending_supported:
          type: boolean
          description: Se este banco informa transações pendentes.
      required:
        - last_synced_at
        - status
        - history_requested_from
        - history_available_from
        - pending_supported
    BankHistoryCoverage:
      type: object
      description: O que o banco entregou do histórico que você solicitou.
      properties:
        requested_from:
          type: string
          description: A data de início que foi solicitada.
          format: date
          nullable: true
        oldest_booking_date:
          type: string
          description: A data de lançamento mais antiga que o banco realmente entregou.
          format: date
          nullable: true
        covered_ranges:
          type: array
          items:
            $ref: '#/components/schemas/BankDateRange'
        missing_ranges:
          type: array
          items:
            $ref: '#/components/schemas/BankDateRange'
        status:
          type: string
          enum:
            - complete
            - partial
            - empty
            - unavailable
            - unknown
          description: >-
            `partial`: o banco entregou menos do que foi solicitado. `empty`: o
            banco confirmou a janela inteira e não há transações. `unavailable`:
            o banco não forneceu histórico. `unknown`: ainda não se sabe.
        extended_auth_used:
          type: boolean
          description: >-
            `true` quando a pessoa deu a confirmação adicional que alguns bancos
            exigem antes de liberar o histórico mais antigo.
      required:
        - requested_from
        - oldest_booking_date
        - covered_ranges
        - missing_ranges
        - status
        - extended_auth_used
    RateLimitBudgetError:
      type: object
      description: >-
        Retornado somente em uma recusa de orçamento de limite de requisições do
        middleware. Outros erros 429, incluindo conflitos de idempotência e
        limites específicos de endpoint, não garantem esses campos de metadados.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Mensagem de recusa por orçamento já existente, legível por humanos.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referência de suporte opaca: RL- seguido de 32 caracteres
            hexadecimais minúsculos de um UUID.
        limit:
          type: integer
          description: Orçamento do escopo excedido; igual a X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: Orçamento restante, limitado a zero; igual a X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Horário de redefinição da janela em segundos Unix; é igual a
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Duração da janela fixa em segundos, não o tempo restante de espera.
            Respeite Retry-After antes de tentar novamente.
      example:
        detail: >-
          Write request rate limit exceeded. You can make up to 300 requests per
          minute.
        reference: RL-00000000000040008000000000000001
        limit: 300
        remaining: 0
        reset: 1794358860
        window_seconds: 60
    BankDateRange:
      type: object
      properties:
        from:
          type: string
          format: date
        to:
          type: string
          format: date
      required:
        - from
        - to
  responses:
    Unauthorized:
      description: Não autorizado
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Chave de API inválida
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        A chave de API não tem a permissão Dados bancários (`bank-data`) ou,
        para dados brutos do banco em uma aplicação em produção, a configuração
        da aplicação "Bank data in the API" está desativada. Dados bancários não
        fazem parte do acesso total: uma chave com acesso total, uma chave
        restrita a outros recursos e uma requisição autenticada sem chave de API
        (credenciais de cliente, para dados brutos) são todas recusadas com este
        corpo, então crie uma chave e conceda a permissão explicitamente. A
        recusa acontece antes de qualquer busca, então ela não informa se um
        objeto existe.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Dados bancários não permitidos
              value:
                code: bank_data_access_denied
                message: >-
                  Bank data calls need an API key that carries the Bank data
                  permission.
                request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                field: null
                next_action: enable_bank_data_access
                retry_after: null
    RateLimitedRead:
      description: >-
        Limite de leitura do middleware excedido. Respeite o Retry-After antes
        de tentar novamente.
      headers:
        Retry-After:
          $ref: '#/components/headers/BudgetRetryAfter'
        X-RateLimit-Scope:
          $ref: '#/components/headers/BudgetXRateLimitScope'
        X-RateLimit-Limit:
          $ref: '#/components/headers/BudgetXRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/BudgetXRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/BudgetXRateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              GET request rate limit exceeded. You can make up to 600 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 600
            remaining: 0
            reset: 1794358860
            window_seconds: 60
    BankDataInternalError:
      description: >-
        Algo deu errado do lado da Didit. Qualquer erro inesperado em
        `/v3/bank/` responde no formato de erro Bank, nunca com uma página HTML:
        informe o `request_id` ao suporte.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Um erro inesperado
              value:
                code: internal_error
                message: >-
                  Something went wrong on our side. Quote the request_id to
                  support.
                request_id: 3f6a1c8e92b54d07a1e38c4b7f0d2e59
                field: null
                next_action: contact_support
                retry_after: null
  headers:
    BudgetRetryAfter:
      description: >-
        Segundos a aguardar, arredondados para cima até a próxima janela.
        Presente nas recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        O escopo cujo orçamento foi excedido. Presente nas recusas de orçamento
        do middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Orçamento do escopo excedido; igual ao limite do corpo. Presente nas
        recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Orçamento restante, limitado a zero; igual a remaining no corpo.
        Presente nas recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Horário da redefinição em segundos Unix; igual à redefinição no corpo.
        Presente nas recusas de orçamento do middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        A chave de API da sua aplicação, obtida em Developers -> API keys no
        Business Console. A chave principal tem acesso completo. Uma chave
        nomeada pode ter escopo limitado: nenhum, leitura ou escrita por
        recurso, restrita a alguns fluxos ou a sessões aprovadas, a uma lista de
        endereços e a uma data de validade. 401 significa que a chave está
        incorreta, revogada ou expirada; 403 significa que nenhuma chave foi
        enviada, que a chave não tem acesso a este recurso ou ação, ou que a
        requisição partiu de um endereço fora da lista de endereços da chave;
        404 em uma rota de sessão significa que a sessão está fora dos fluxos ou
        status permitidos para a chave. Uma chave sem acesso a mídia recebe as
        URLs de imagem, vídeo e PDF como null, e uma chave sem escrita de
        sessões recebe os links e tokens de sessão como null. Veja
        https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.