Create an Instrument Account
curl --request POST \
--url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments \
--header 'Content-Type: application/json' \
--data '
{
"accountId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2025-01-01T00:00:00Z",
"deletedAt": "2025-01-01T00:00:00Z",
"holderId": "00000000-0000-0000-0000-000000000000",
"ledgerId": "00000000-0000-0000-0000-000000000000",
"updatedAt": "2025-01-01T00:00:00Z",
"bankingDetails": {
"account": "123450",
"bankId": "12345",
"branch": "0001",
"closingDate": "2025-12-31",
"countryCode": "US",
"iban": "US12345678901234567890",
"openingDate": "2025-01-01",
"type": "CACC"
},
"document": "91315026015",
"id": "00000000-0000-0000-0000-000000000000",
"metadata": {},
"regulatoryFields": {
"participantDocument": "12345678912345"
},
"relatedParties": [
{
"document": "12345678900",
"name": "John Smith",
"role": "PRIMARY_HOLDER",
"startDate": "2025-01-01",
"endDate": "2026-01-01",
"id": "00000000-0000-0000-0000-000000000000"
}
],
"type": "NATURAL_PERSON"
}
'import requests
url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments"
payload = {
"accountId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2025-01-01T00:00:00Z",
"deletedAt": "2025-01-01T00:00:00Z",
"holderId": "00000000-0000-0000-0000-000000000000",
"ledgerId": "00000000-0000-0000-0000-000000000000",
"updatedAt": "2025-01-01T00:00:00Z",
"bankingDetails": {
"account": "123450",
"bankId": "12345",
"branch": "0001",
"closingDate": "2025-12-31",
"countryCode": "US",
"iban": "US12345678901234567890",
"openingDate": "2025-01-01",
"type": "CACC"
},
"document": "91315026015",
"id": "00000000-0000-0000-0000-000000000000",
"metadata": {},
"regulatoryFields": { "participantDocument": "12345678912345" },
"relatedParties": [
{
"document": "12345678900",
"name": "John Smith",
"role": "PRIMARY_HOLDER",
"startDate": "2025-01-01",
"endDate": "2026-01-01",
"id": "00000000-0000-0000-0000-000000000000"
}
],
"type": "NATURAL_PERSON"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
accountId: '00000000-0000-0000-0000-000000000000',
createdAt: '2025-01-01T00:00:00Z',
deletedAt: '2025-01-01T00:00:00Z',
holderId: '00000000-0000-0000-0000-000000000000',
ledgerId: '00000000-0000-0000-0000-000000000000',
updatedAt: '2025-01-01T00:00:00Z',
bankingDetails: {
account: '123450',
bankId: '12345',
branch: '0001',
closingDate: '2025-12-31',
countryCode: 'US',
iban: 'US12345678901234567890',
openingDate: '2025-01-01',
type: 'CACC'
},
document: '91315026015',
id: '00000000-0000-0000-0000-000000000000',
metadata: {},
regulatoryFields: {participantDocument: '12345678912345'},
relatedParties: [
{
document: '12345678900',
name: 'John Smith',
role: 'PRIMARY_HOLDER',
startDate: '2025-01-01',
endDate: '2026-01-01',
id: '00000000-0000-0000-0000-000000000000'
}
],
type: 'NATURAL_PERSON'
})
};
fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'accountId' => '00000000-0000-0000-0000-000000000000',
'createdAt' => '2025-01-01T00:00:00Z',
'deletedAt' => '2025-01-01T00:00:00Z',
'holderId' => '00000000-0000-0000-0000-000000000000',
'ledgerId' => '00000000-0000-0000-0000-000000000000',
'updatedAt' => '2025-01-01T00:00:00Z',
'bankingDetails' => [
'account' => '123450',
'bankId' => '12345',
'branch' => '0001',
'closingDate' => '2025-12-31',
'countryCode' => 'US',
'iban' => 'US12345678901234567890',
'openingDate' => '2025-01-01',
'type' => 'CACC'
],
'document' => '91315026015',
'id' => '00000000-0000-0000-0000-000000000000',
'metadata' => [
],
'regulatoryFields' => [
'participantDocument' => '12345678912345'
],
'relatedParties' => [
[
'document' => '12345678900',
'name' => 'John Smith',
'role' => 'PRIMARY_HOLDER',
'startDate' => '2025-01-01',
'endDate' => '2026-01-01',
'id' => '00000000-0000-0000-0000-000000000000'
]
],
'type' => 'NATURAL_PERSON'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments"
payload := strings.NewReader("{\n \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n \"createdAt\": \"2025-01-01T00:00:00Z\",\n \"deletedAt\": \"2025-01-01T00:00:00Z\",\n \"holderId\": \"00000000-0000-0000-0000-000000000000\",\n \"ledgerId\": \"00000000-0000-0000-0000-000000000000\",\n \"updatedAt\": \"2025-01-01T00:00:00Z\",\n \"bankingDetails\": {\n \"account\": \"123450\",\n \"bankId\": \"12345\",\n \"branch\": \"0001\",\n \"closingDate\": \"2025-12-31\",\n \"countryCode\": \"US\",\n \"iban\": \"US12345678901234567890\",\n \"openingDate\": \"2025-01-01\",\n \"type\": \"CACC\"\n },\n \"document\": \"91315026015\",\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"metadata\": {},\n \"regulatoryFields\": {\n \"participantDocument\": \"12345678912345\"\n },\n \"relatedParties\": [\n {\n \"document\": \"12345678900\",\n \"name\": \"John Smith\",\n \"role\": \"PRIMARY_HOLDER\",\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2026-01-01\",\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n }\n ],\n \"type\": \"NATURAL_PERSON\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments")
.header("Content-Type", "application/json")
.body("{\n \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n \"createdAt\": \"2025-01-01T00:00:00Z\",\n \"deletedAt\": \"2025-01-01T00:00:00Z\",\n \"holderId\": \"00000000-0000-0000-0000-000000000000\",\n \"ledgerId\": \"00000000-0000-0000-0000-000000000000\",\n \"updatedAt\": \"2025-01-01T00:00:00Z\",\n \"bankingDetails\": {\n \"account\": \"123450\",\n \"bankId\": \"12345\",\n \"branch\": \"0001\",\n \"closingDate\": \"2025-12-31\",\n \"countryCode\": \"US\",\n \"iban\": \"US12345678901234567890\",\n \"openingDate\": \"2025-01-01\",\n \"type\": \"CACC\"\n },\n \"document\": \"91315026015\",\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"metadata\": {},\n \"regulatoryFields\": {\n \"participantDocument\": \"12345678912345\"\n },\n \"relatedParties\": [\n {\n \"document\": \"12345678900\",\n \"name\": \"John Smith\",\n \"role\": \"PRIMARY_HOLDER\",\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2026-01-01\",\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n }\n ],\n \"type\": \"NATURAL_PERSON\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n \"createdAt\": \"2025-01-01T00:00:00Z\",\n \"deletedAt\": \"2025-01-01T00:00:00Z\",\n \"holderId\": \"00000000-0000-0000-0000-000000000000\",\n \"ledgerId\": \"00000000-0000-0000-0000-000000000000\",\n \"updatedAt\": \"2025-01-01T00:00:00Z\",\n \"bankingDetails\": {\n \"account\": \"123450\",\n \"bankId\": \"12345\",\n \"branch\": \"0001\",\n \"closingDate\": \"2025-12-31\",\n \"countryCode\": \"US\",\n \"iban\": \"US12345678901234567890\",\n \"openingDate\": \"2025-01-01\",\n \"type\": \"CACC\"\n },\n \"document\": \"91315026015\",\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"metadata\": {},\n \"regulatoryFields\": {\n \"participantDocument\": \"12345678912345\"\n },\n \"relatedParties\": [\n {\n \"document\": \"12345678900\",\n \"name\": \"John Smith\",\n \"role\": \"PRIMARY_HOLDER\",\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2026-01-01\",\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n }\n ],\n \"type\": \"NATURAL_PERSON\"\n}"
response = http.request(request)
puts response.read_body{
"accountId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2025-01-01T00:00:00Z",
"deletedAt": "2025-01-01T00:00:00Z",
"holderId": "00000000-0000-0000-0000-000000000000",
"ledgerId": "00000000-0000-0000-0000-000000000000",
"updatedAt": "2025-01-01T00:00:00Z",
"bankingDetails": {
"account": "123450",
"bankId": "12345",
"branch": "0001",
"closingDate": "2025-12-31",
"countryCode": "US",
"iban": "US12345678901234567890",
"openingDate": "2025-01-01",
"type": "CACC"
},
"document": "91315026015",
"id": "00000000-0000-0000-0000-000000000000",
"metadata": {},
"regulatoryFields": {
"participantDocument": "12345678912345"
},
"relatedParties": [
{
"document": "12345678900",
"name": "John Smith",
"role": "PRIMARY_HOLDER",
"startDate": "2025-01-01",
"endDate": "2026-01-01",
"id": "00000000-0000-0000-0000-000000000000"
}
],
"type": "NATURAL_PERSON"
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Create an Instrument Account
POST
/
v1
/
organizations
/
{organization_id}
/
holders
/
{holder_id}
/
instruments
Create an Instrument Account
curl --request POST \
--url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments \
--header 'Content-Type: application/json' \
--data '
{
"accountId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2025-01-01T00:00:00Z",
"deletedAt": "2025-01-01T00:00:00Z",
"holderId": "00000000-0000-0000-0000-000000000000",
"ledgerId": "00000000-0000-0000-0000-000000000000",
"updatedAt": "2025-01-01T00:00:00Z",
"bankingDetails": {
"account": "123450",
"bankId": "12345",
"branch": "0001",
"closingDate": "2025-12-31",
"countryCode": "US",
"iban": "US12345678901234567890",
"openingDate": "2025-01-01",
"type": "CACC"
},
"document": "91315026015",
"id": "00000000-0000-0000-0000-000000000000",
"metadata": {},
"regulatoryFields": {
"participantDocument": "12345678912345"
},
"relatedParties": [
{
"document": "12345678900",
"name": "John Smith",
"role": "PRIMARY_HOLDER",
"startDate": "2025-01-01",
"endDate": "2026-01-01",
"id": "00000000-0000-0000-0000-000000000000"
}
],
"type": "NATURAL_PERSON"
}
'import requests
url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments"
payload = {
"accountId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2025-01-01T00:00:00Z",
"deletedAt": "2025-01-01T00:00:00Z",
"holderId": "00000000-0000-0000-0000-000000000000",
"ledgerId": "00000000-0000-0000-0000-000000000000",
"updatedAt": "2025-01-01T00:00:00Z",
"bankingDetails": {
"account": "123450",
"bankId": "12345",
"branch": "0001",
"closingDate": "2025-12-31",
"countryCode": "US",
"iban": "US12345678901234567890",
"openingDate": "2025-01-01",
"type": "CACC"
},
"document": "91315026015",
"id": "00000000-0000-0000-0000-000000000000",
"metadata": {},
"regulatoryFields": { "participantDocument": "12345678912345" },
"relatedParties": [
{
"document": "12345678900",
"name": "John Smith",
"role": "PRIMARY_HOLDER",
"startDate": "2025-01-01",
"endDate": "2026-01-01",
"id": "00000000-0000-0000-0000-000000000000"
}
],
"type": "NATURAL_PERSON"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
accountId: '00000000-0000-0000-0000-000000000000',
createdAt: '2025-01-01T00:00:00Z',
deletedAt: '2025-01-01T00:00:00Z',
holderId: '00000000-0000-0000-0000-000000000000',
ledgerId: '00000000-0000-0000-0000-000000000000',
updatedAt: '2025-01-01T00:00:00Z',
bankingDetails: {
account: '123450',
bankId: '12345',
branch: '0001',
closingDate: '2025-12-31',
countryCode: 'US',
iban: 'US12345678901234567890',
openingDate: '2025-01-01',
type: 'CACC'
},
document: '91315026015',
id: '00000000-0000-0000-0000-000000000000',
metadata: {},
regulatoryFields: {participantDocument: '12345678912345'},
relatedParties: [
{
document: '12345678900',
name: 'John Smith',
role: 'PRIMARY_HOLDER',
startDate: '2025-01-01',
endDate: '2026-01-01',
id: '00000000-0000-0000-0000-000000000000'
}
],
type: 'NATURAL_PERSON'
})
};
fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'accountId' => '00000000-0000-0000-0000-000000000000',
'createdAt' => '2025-01-01T00:00:00Z',
'deletedAt' => '2025-01-01T00:00:00Z',
'holderId' => '00000000-0000-0000-0000-000000000000',
'ledgerId' => '00000000-0000-0000-0000-000000000000',
'updatedAt' => '2025-01-01T00:00:00Z',
'bankingDetails' => [
'account' => '123450',
'bankId' => '12345',
'branch' => '0001',
'closingDate' => '2025-12-31',
'countryCode' => 'US',
'iban' => 'US12345678901234567890',
'openingDate' => '2025-01-01',
'type' => 'CACC'
],
'document' => '91315026015',
'id' => '00000000-0000-0000-0000-000000000000',
'metadata' => [
],
'regulatoryFields' => [
'participantDocument' => '12345678912345'
],
'relatedParties' => [
[
'document' => '12345678900',
'name' => 'John Smith',
'role' => 'PRIMARY_HOLDER',
'startDate' => '2025-01-01',
'endDate' => '2026-01-01',
'id' => '00000000-0000-0000-0000-000000000000'
]
],
'type' => 'NATURAL_PERSON'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments"
payload := strings.NewReader("{\n \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n \"createdAt\": \"2025-01-01T00:00:00Z\",\n \"deletedAt\": \"2025-01-01T00:00:00Z\",\n \"holderId\": \"00000000-0000-0000-0000-000000000000\",\n \"ledgerId\": \"00000000-0000-0000-0000-000000000000\",\n \"updatedAt\": \"2025-01-01T00:00:00Z\",\n \"bankingDetails\": {\n \"account\": \"123450\",\n \"bankId\": \"12345\",\n \"branch\": \"0001\",\n \"closingDate\": \"2025-12-31\",\n \"countryCode\": \"US\",\n \"iban\": \"US12345678901234567890\",\n \"openingDate\": \"2025-01-01\",\n \"type\": \"CACC\"\n },\n \"document\": \"91315026015\",\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"metadata\": {},\n \"regulatoryFields\": {\n \"participantDocument\": \"12345678912345\"\n },\n \"relatedParties\": [\n {\n \"document\": \"12345678900\",\n \"name\": \"John Smith\",\n \"role\": \"PRIMARY_HOLDER\",\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2026-01-01\",\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n }\n ],\n \"type\": \"NATURAL_PERSON\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments")
.header("Content-Type", "application/json")
.body("{\n \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n \"createdAt\": \"2025-01-01T00:00:00Z\",\n \"deletedAt\": \"2025-01-01T00:00:00Z\",\n \"holderId\": \"00000000-0000-0000-0000-000000000000\",\n \"ledgerId\": \"00000000-0000-0000-0000-000000000000\",\n \"updatedAt\": \"2025-01-01T00:00:00Z\",\n \"bankingDetails\": {\n \"account\": \"123450\",\n \"bankId\": \"12345\",\n \"branch\": \"0001\",\n \"closingDate\": \"2025-12-31\",\n \"countryCode\": \"US\",\n \"iban\": \"US12345678901234567890\",\n \"openingDate\": \"2025-01-01\",\n \"type\": \"CACC\"\n },\n \"document\": \"91315026015\",\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"metadata\": {},\n \"regulatoryFields\": {\n \"participantDocument\": \"12345678912345\"\n },\n \"relatedParties\": [\n {\n \"document\": \"12345678900\",\n \"name\": \"John Smith\",\n \"role\": \"PRIMARY_HOLDER\",\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2026-01-01\",\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n }\n ],\n \"type\": \"NATURAL_PERSON\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountId\": \"00000000-0000-0000-0000-000000000000\",\n \"createdAt\": \"2025-01-01T00:00:00Z\",\n \"deletedAt\": \"2025-01-01T00:00:00Z\",\n \"holderId\": \"00000000-0000-0000-0000-000000000000\",\n \"ledgerId\": \"00000000-0000-0000-0000-000000000000\",\n \"updatedAt\": \"2025-01-01T00:00:00Z\",\n \"bankingDetails\": {\n \"account\": \"123450\",\n \"bankId\": \"12345\",\n \"branch\": \"0001\",\n \"closingDate\": \"2025-12-31\",\n \"countryCode\": \"US\",\n \"iban\": \"US12345678901234567890\",\n \"openingDate\": \"2025-01-01\",\n \"type\": \"CACC\"\n },\n \"document\": \"91315026015\",\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"metadata\": {},\n \"regulatoryFields\": {\n \"participantDocument\": \"12345678912345\"\n },\n \"relatedParties\": [\n {\n \"document\": \"12345678900\",\n \"name\": \"John Smith\",\n \"role\": \"PRIMARY_HOLDER\",\n \"startDate\": \"2025-01-01\",\n \"endDate\": \"2026-01-01\",\n \"id\": \"00000000-0000-0000-0000-000000000000\"\n }\n ],\n \"type\": \"NATURAL_PERSON\"\n}"
response = http.request(request)
puts response.read_body{
"accountId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2025-01-01T00:00:00Z",
"deletedAt": "2025-01-01T00:00:00Z",
"holderId": "00000000-0000-0000-0000-000000000000",
"ledgerId": "00000000-0000-0000-0000-000000000000",
"updatedAt": "2025-01-01T00:00:00Z",
"bankingDetails": {
"account": "123450",
"bankId": "12345",
"branch": "0001",
"closingDate": "2025-12-31",
"countryCode": "US",
"iban": "US12345678901234567890",
"openingDate": "2025-01-01",
"type": "CACC"
},
"document": "91315026015",
"id": "00000000-0000-0000-0000-000000000000",
"metadata": {},
"regulatoryFields": {
"participantDocument": "12345678912345"
},
"relatedParties": [
{
"document": "12345678900",
"name": "John Smith",
"role": "PRIMARY_HOLDER",
"startDate": "2025-01-01",
"endDate": "2026-01-01",
"id": "00000000-0000-0000-0000-000000000000"
}
],
"type": "NATURAL_PERSON"
}{
"code": "ERR-0001",
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Headers
The type of media of the resource. Recommended value is application/json.
A unique identifier used to trace and track each request.
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>
A unique key that ensures transaction idempotency. If not provided, the system automatically generates a SHA-256 hash based on the request body. Keys are scoped per organization and ledger.
Always validate the X-Idempotency-Replayed response header to distinguish new transactions from cached replays.
See Retries and idempotency for best practices.
The time-to-live for the idempotency key, defined in seconds. Defaults to 300 seconds (5 minutes) if not provided. Only the TTL from the first request is used; changing it on retries has no effect.
See Retries and idempotency for details.
Path Parameters
The unique identifier of the Organization associated with the Ledger.
Holder ID (UUID)
Body
application/json
Example:
"00000000-0000-0000-0000-000000000000"
Example:
"2025-01-01T00:00:00Z"
Example:
"2025-01-01T00:00:00Z"
Example:
"00000000-0000-0000-0000-000000000000"
Example:
"00000000-0000-0000-0000-000000000000"
Example:
"2025-01-01T00:00:00Z"
Show child attributes
Show child attributes
Maximum string length:
100Example:
"91315026015"
Example:
"00000000-0000-0000-0000-000000000000"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
100Example:
"NATURAL_PERSON"
Response
OK
Example:
"00000000-0000-0000-0000-000000000000"
Example:
"2025-01-01T00:00:00Z"
Example:
"2025-01-01T00:00:00Z"
Example:
"00000000-0000-0000-0000-000000000000"
Example:
"00000000-0000-0000-0000-000000000000"
Example:
"2025-01-01T00:00:00Z"
Show child attributes
Show child attributes
Maximum string length:
100Example:
"91315026015"
Example:
"00000000-0000-0000-0000-000000000000"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
100Example:
"NATURAL_PERSON"
Was this page helpful?