Skip to main content
GET
Consultar detalhes do Instrumento

Cabeçalhos

X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Authorization
string

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 <token>

Parâmetros de caminho

organization_id
string<uuid>
obrigatório

O identificador único da Organização associada ao Ledger.

holder_id
string
obrigatório

ID do titular (UUID)

instrument_id
string
obrigatório

ID do instrumento (UUID)

Parâmetros de consulta

include_deleted
string

Retorna o instrumento mesmo que ele tenha sido excluído logicamente (true,false)

Resposta

OK

accountId
string<uuid> | null
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

createdAt
string<date-time>
obrigatório
Exemplo:

"2025-01-01T00:00:00Z"

deletedAt
string<date-time> | null
obrigatório
Exemplo:

"2025-01-01T00:00:00Z"

holderId
string<uuid>
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId
string<uuid> | null
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

updatedAt
string<date-time>
obrigatório
Exemplo:

"2025-01-01T00:00:00Z"

bankingDetails
object
document
string
Maximum string length: 100
Exemplo:

"91315026015"

id
string<uuid>
Exemplo:

"00000000-0000-0000-0000-000000000000"

metadata
object
regulatoryFields
object
type
string
Maximum string length: 100
Exemplo:

"NATURAL_PERSON"