Skip to main content
GET
Consultar detalles del instrumento

Encabezados

X-Request-Id
string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Authorization
string

Token JWT bearer para autenticación. Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: Bearer <token>

Parámetros de ruta

organization_id
string<uuid>
requerido

El identificador único de la Organización asociada al Ledger.

holder_id
string
requerido

ID del titular (UUID)

instrument_id
string
requerido

ID del instrumento (UUID)

Parámetros de consulta

include_deleted
string

Returns the instrument even if it was logically deleted (true,false) Devuelve el instrumento aunque haya sido eliminado lógicamente (true,false)

Respuesta

OK

accountId
string<uuid> | null
requerido
Ejemplo:

"00000000-0000-0000-0000-000000000000"

createdAt
string<date-time>
requerido
Ejemplo:

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

deletedAt
string<date-time> | null
requerido
Ejemplo:

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

holderId
string<uuid>
requerido
Ejemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId
string<uuid> | null
requerido
Ejemplo:

"00000000-0000-0000-0000-000000000000"

updatedAt
string<date-time>
requerido
Ejemplo:

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

bankingDetails
object
document
string
Maximum string length: 100
Ejemplo:

"91315026015"

id
string<uuid>
Ejemplo:

"00000000-0000-0000-0000-000000000000"

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

"NATURAL_PERSON"