> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Consultar detalhes do Instrumento ## OpenAPI ````yaml pt/openapi/v3-current/ledger.yaml get /v1/organizations/{organization_id}/holders/{holder_id}/instruments/{instrument_id} openapi: 3.1.0 info: title: API Midaz Ledger description: >- Referência completa da API para serviços do Midaz Ledger incluindo gerenciamento de organizações, operações de ledger, ativos, segmentos, portfolios, contas, tipos de conta, transações, operações, saldos, rotas de operação, rotas de transação e índices de metadata. version: 3.7.8 servers: - url: https://ledger.sandbox.lerian.net security: [] tags: - name: API de Organizações - name: API de Ledgers - name: API de Ativos - name: API de Segmentos - name: API de Portfolios - name: API de Tipos de Conta - name: API de Contas - name: API de Saldos - name: API de Transações - name: API de Operações - name: API de Rotas de Operação - name: API de Rotas de Transação - name: API de Índices de Metadata - name: API de Titulares - name: API de Instrumentos - name: API de Pacotes de Cobrança - name: API de Pacotes - name: API de Cálculo de Cobrança - name: API de Estimativa - name: API de Criptografia - name: API de Proteção - name: API de Taxas de Ativos paths: /v1/organizations/{organization_id}/holders/{holder_id}/instruments/{instrument_id}: get: tags: - API de Instrumentos summary: Consultar detalhes do Instrumento parameters: - $ref: '#/components/parameters/OrganizationId' - name: holder_id in: path required: true description: ID do titular (UUID) schema: type: string - name: instrument_id in: path required: true description: ID do instrumento (UUID) schema: type: string - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Authorization' - description: >- Retorna o instrumento mesmo que ele tenha sido excluído logicamente (true,false) explode: false in: query name: include_deleted schema: description: >- Retorna o instrumento mesmo que ele tenha sido excluído logicamente (true,false) type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Instrument' default: description: Erro content: application/problem+json: schema: $ref: '#/components/schemas/Error' components: parameters: OrganizationId: name: organization_id in: path description: O identificador único da Organização associada ao Ledger. required: true example: 019c96a0-0a98-7287-9a31-786e0809c769 schema: type: string format: uuid XRequestId: name: X-Request-Id in: header description: >- Um identificador único utilizado para rastrear e acompanhar cada requisição. required: false example: 019c96a0-0a98-7287-9a31-786e0809c769 schema: type: string format: uuid Authorization: name: Authorization in: header required: false schema: type: string description: > Token JWT bearer para autenticação. Obrigatório quando `PLUGIN_AUTH_ENABLED=true` (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: `Bearer ` schemas: Instrument: additionalProperties: false properties: accountId: examples: - 00000000-0000-0000-0000-000000000000 format: uuid type: - string - 'null' bankingDetails: $ref: '#/components/schemas/BankingDetails' createdAt: examples: - '2025-01-01T00:00:00Z' format: date-time type: string deletedAt: examples: - '2025-01-01T00:00:00Z' format: date-time type: - string - 'null' document: examples: - '91315026015' maxLength: 100 type: string holderId: examples: - 00000000-0000-0000-0000-000000000000 format: uuid type: string id: examples: - 00000000-0000-0000-0000-000000000000 format: uuid type: string ledgerId: examples: - 00000000-0000-0000-0000-000000000000 format: uuid type: - string - 'null' metadata: additionalProperties: {} type: object regulatoryFields: $ref: '#/components/schemas/RegulatoryFields' relatedParties: items: $ref: '#/components/schemas/RelatedParty' type: - array - 'null' type: examples: - NATURAL_PERSON maxLength: 100 type: string updatedAt: examples: - '2025-01-01T00:00:00Z' format: date-time type: string required: - ledgerId - accountId - holderId - createdAt - updatedAt - deletedAt type: object Error: additionalProperties: false properties: code: description: >- Código de erro de domínio estável e legível por máquina, com escopo no serviço emissor (formato: -NNNN). examples: - ERR-0001 type: string detail: description: >- Uma explicação legível por humanos específica para esta ocorrência do problema. examples: - Property foo is required but is missing. type: string errors: description: Lista opcional de detalhes de erro individuais items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- Uma referência de URI que identifica a ocorrência específica do problema. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: Código de status HTTP examples: - 400 format: int64 type: integer title: description: >- Um resumo curto e legível por humanos do tipo de problema. Este valor não deve mudar entre ocorrências do erro. examples: - Bad Request type: string type: default: about:blank description: >- Uma referência de URI para a documentação legível por humanos do erro. examples: - https://example.com/errors/example format: uri type: string type: object BankingDetails: additionalProperties: false properties: account: examples: - '123450' maxLength: 50 type: string bankId: examples: - '12345' maxLength: 50 type: string branch: examples: - '0001' maxLength: 50 type: string closingDate: examples: - '2025-12-31' format: date type: string countryCode: examples: - US maxLength: 2 type: string iban: examples: - US12345678901234567890 maxLength: 34 type: string openingDate: examples: - '2025-01-01' format: date type: string type: examples: - CACC maxLength: 10 type: string type: object RegulatoryFields: additionalProperties: false properties: participantDocument: examples: - '12345678912345' maxLength: 100 type: string type: object RelatedParty: additionalProperties: false properties: document: examples: - '12345678900' maxLength: 100 type: string endDate: examples: - '2026-01-01' format: date type: string id: examples: - 00000000-0000-0000-0000-000000000000 format: uuid type: string name: examples: - John Smith maxLength: 256 type: string role: examples: - PRIMARY_HOLDER maxLength: 100 type: string startDate: examples: - '2025-01-01' format: date type: string required: - document - name - role - startDate type: object ErrorDetail: additionalProperties: false properties: location: description: >- Onde o erro ocorreu, por exemplo 'body.items[3].tags' ou 'path.thing-id' type: string message: description: Texto da mensagem de erro type: string value: description: O valor na localização informada type: object ````