Skip to main content
GET
Retrieve Instrument details

Headers

X-Request-Id
string<uuid>

A unique identifier used to trace and track each request.

Authorization
string

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Path Parameters

organization_id
string<uuid>
required

The unique identifier of the Organization associated with the Ledger.

holder_id
string
required

Holder ID (UUID)

instrument_id
string
required

Instrument ID (UUID)

Query Parameters

include_deleted
string

Returns the instrument even if it was logically deleted (true,false)

Response

OK

accountId
string<uuid> | null
required
Example:

"00000000-0000-0000-0000-000000000000"

createdAt
string<date-time>
required
Example:

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

deletedAt
string<date-time> | null
required
Example:

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

holderId
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

ledgerId
string<uuid> | null
required
Example:

"00000000-0000-0000-0000-000000000000"

updatedAt
string<date-time>
required
Example:

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

bankingDetails
object
document
string
Maximum string length: 100
Example:

"91315026015"

id
string<uuid>
Example:

"00000000-0000-0000-0000-000000000000"

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

"NATURAL_PERSON"