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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"bankingDetails": {
"account": "<string>",
"bankId": "<string>",
"branch": "<string>",
"closingDate": "2023-12-25",
"countryCode": "<string>",
"iban": "<string>",
"openingDate": "2023-12-25",
"type": "<string>"
},
"document": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"regulatoryFields": {
"participantDocument": "<string>"
},
"relatedParties": [
{
"document": "<string>",
"name": "<string>",
"role": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"type": "<string>"
}
'import requests
url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments"
payload = {
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"bankingDetails": {
"account": "<string>",
"bankId": "<string>",
"branch": "<string>",
"closingDate": "2023-12-25",
"countryCode": "<string>",
"iban": "<string>",
"openingDate": "2023-12-25",
"type": "<string>"
},
"document": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"regulatoryFields": { "participantDocument": "<string>" },
"relatedParties": [
{
"document": "<string>",
"name": "<string>",
"role": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"type": "<string>"
}
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: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
createdAt: '2023-11-07T05:31:56Z',
deletedAt: '2023-11-07T05:31:56Z',
holderId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ledgerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
updatedAt: '2023-11-07T05:31:56Z',
bankingDetails: {
account: '<string>',
bankId: '<string>',
branch: '<string>',
closingDate: '2023-12-25',
countryCode: '<string>',
iban: '<string>',
openingDate: '2023-12-25',
type: '<string>'
},
document: '<string>',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {},
regulatoryFields: {participantDocument: '<string>'},
relatedParties: [
{
document: '<string>',
name: '<string>',
role: '<string>',
startDate: '2023-12-25',
endDate: '2023-12-25',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
type: '<string>'
})
};
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' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'createdAt' => '2023-11-07T05:31:56Z',
'deletedAt' => '2023-11-07T05:31:56Z',
'holderId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'ledgerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'updatedAt' => '2023-11-07T05:31:56Z',
'bankingDetails' => [
'account' => '<string>',
'bankId' => '<string>',
'branch' => '<string>',
'closingDate' => '2023-12-25',
'countryCode' => '<string>',
'iban' => '<string>',
'openingDate' => '2023-12-25',
'type' => '<string>'
],
'document' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'metadata' => [
],
'regulatoryFields' => [
'participantDocument' => '<string>'
],
'relatedParties' => [
[
'document' => '<string>',
'name' => '<string>',
'role' => '<string>',
'startDate' => '2023-12-25',
'endDate' => '2023-12-25',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'type' => '<string>'
]),
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\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"holderId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ledgerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"bankingDetails\": {\n \"account\": \"<string>\",\n \"bankId\": \"<string>\",\n \"branch\": \"<string>\",\n \"closingDate\": \"2023-12-25\",\n \"countryCode\": \"<string>\",\n \"iban\": \"<string>\",\n \"openingDate\": \"2023-12-25\",\n \"type\": \"<string>\"\n },\n \"document\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"regulatoryFields\": {\n \"participantDocument\": \"<string>\"\n },\n \"relatedParties\": [\n {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"type\": \"<string>\"\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\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"holderId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ledgerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"bankingDetails\": {\n \"account\": \"<string>\",\n \"bankId\": \"<string>\",\n \"branch\": \"<string>\",\n \"closingDate\": \"2023-12-25\",\n \"countryCode\": \"<string>\",\n \"iban\": \"<string>\",\n \"openingDate\": \"2023-12-25\",\n \"type\": \"<string>\"\n },\n \"document\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"regulatoryFields\": {\n \"participantDocument\": \"<string>\"\n },\n \"relatedParties\": [\n {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"type\": \"<string>\"\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\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"holderId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ledgerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"bankingDetails\": {\n \"account\": \"<string>\",\n \"bankId\": \"<string>\",\n \"branch\": \"<string>\",\n \"closingDate\": \"2023-12-25\",\n \"countryCode\": \"<string>\",\n \"iban\": \"<string>\",\n \"openingDate\": \"2023-12-25\",\n \"type\": \"<string>\"\n },\n \"document\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"regulatoryFields\": {\n \"participantDocument\": \"<string>\"\n },\n \"relatedParties\": [\n {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"bankingDetails": {
"account": "<string>",
"bankId": "<string>",
"branch": "<string>",
"closingDate": "2023-12-25",
"countryCode": "<string>",
"iban": "<string>",
"openingDate": "2023-12-25",
"type": "<string>"
},
"document": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"regulatoryFields": {
"participantDocument": "<string>"
},
"relatedParties": [
{
"document": "<string>",
"name": "<string>",
"role": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"type": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"bankingDetails": {
"account": "<string>",
"bankId": "<string>",
"branch": "<string>",
"closingDate": "2023-12-25",
"countryCode": "<string>",
"iban": "<string>",
"openingDate": "2023-12-25",
"type": "<string>"
},
"document": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"regulatoryFields": {
"participantDocument": "<string>"
},
"relatedParties": [
{
"document": "<string>",
"name": "<string>",
"role": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"type": "<string>"
}
'import requests
url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/holders/{holder_id}/instruments"
payload = {
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"bankingDetails": {
"account": "<string>",
"bankId": "<string>",
"branch": "<string>",
"closingDate": "2023-12-25",
"countryCode": "<string>",
"iban": "<string>",
"openingDate": "2023-12-25",
"type": "<string>"
},
"document": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"regulatoryFields": { "participantDocument": "<string>" },
"relatedParties": [
{
"document": "<string>",
"name": "<string>",
"role": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"type": "<string>"
}
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: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
createdAt: '2023-11-07T05:31:56Z',
deletedAt: '2023-11-07T05:31:56Z',
holderId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ledgerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
updatedAt: '2023-11-07T05:31:56Z',
bankingDetails: {
account: '<string>',
bankId: '<string>',
branch: '<string>',
closingDate: '2023-12-25',
countryCode: '<string>',
iban: '<string>',
openingDate: '2023-12-25',
type: '<string>'
},
document: '<string>',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
metadata: {},
regulatoryFields: {participantDocument: '<string>'},
relatedParties: [
{
document: '<string>',
name: '<string>',
role: '<string>',
startDate: '2023-12-25',
endDate: '2023-12-25',
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
],
type: '<string>'
})
};
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' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'createdAt' => '2023-11-07T05:31:56Z',
'deletedAt' => '2023-11-07T05:31:56Z',
'holderId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'ledgerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'updatedAt' => '2023-11-07T05:31:56Z',
'bankingDetails' => [
'account' => '<string>',
'bankId' => '<string>',
'branch' => '<string>',
'closingDate' => '2023-12-25',
'countryCode' => '<string>',
'iban' => '<string>',
'openingDate' => '2023-12-25',
'type' => '<string>'
],
'document' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'metadata' => [
],
'regulatoryFields' => [
'participantDocument' => '<string>'
],
'relatedParties' => [
[
'document' => '<string>',
'name' => '<string>',
'role' => '<string>',
'startDate' => '2023-12-25',
'endDate' => '2023-12-25',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
],
'type' => '<string>'
]),
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\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"holderId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ledgerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"bankingDetails\": {\n \"account\": \"<string>\",\n \"bankId\": \"<string>\",\n \"branch\": \"<string>\",\n \"closingDate\": \"2023-12-25\",\n \"countryCode\": \"<string>\",\n \"iban\": \"<string>\",\n \"openingDate\": \"2023-12-25\",\n \"type\": \"<string>\"\n },\n \"document\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"regulatoryFields\": {\n \"participantDocument\": \"<string>\"\n },\n \"relatedParties\": [\n {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"type\": \"<string>\"\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\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"holderId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ledgerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"bankingDetails\": {\n \"account\": \"<string>\",\n \"bankId\": \"<string>\",\n \"branch\": \"<string>\",\n \"closingDate\": \"2023-12-25\",\n \"countryCode\": \"<string>\",\n \"iban\": \"<string>\",\n \"openingDate\": \"2023-12-25\",\n \"type\": \"<string>\"\n },\n \"document\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"regulatoryFields\": {\n \"participantDocument\": \"<string>\"\n },\n \"relatedParties\": [\n {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"type\": \"<string>\"\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\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"holderId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ledgerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\",\n \"bankingDetails\": {\n \"account\": \"<string>\",\n \"bankId\": \"<string>\",\n \"branch\": \"<string>\",\n \"closingDate\": \"2023-12-25\",\n \"countryCode\": \"<string>\",\n \"iban\": \"<string>\",\n \"openingDate\": \"2023-12-25\",\n \"type\": \"<string>\"\n },\n \"document\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"metadata\": {},\n \"regulatoryFields\": {\n \"participantDocument\": \"<string>\"\n },\n \"relatedParties\": [\n {\n \"document\": \"<string>\",\n \"name\": \"<string>\",\n \"role\": \"<string>\",\n \"startDate\": \"2023-12-25\",\n \"endDate\": \"2023-12-25\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ],\n \"type\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updatedAt": "2023-11-07T05:31:56Z",
"bankingDetails": {
"account": "<string>",
"bankId": "<string>",
"branch": "<string>",
"closingDate": "2023-12-25",
"countryCode": "<string>",
"iban": "<string>",
"openingDate": "2023-12-25",
"type": "<string>"
},
"document": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {},
"regulatoryFields": {
"participantDocument": "<string>"
},
"relatedParties": [
{
"document": "<string>",
"name": "<string>",
"role": "<string>",
"startDate": "2023-12-25",
"endDate": "2023-12-25",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"type": "<string>"
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "about:blank"
}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?
⌘I