Open a holder-owned account (with optional instrument)

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/holders/{holder_id}/accounts

const options = {method: 'POST'};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/holders/{holder_id}/accounts', 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}/ledgers/{ledger_id}/holders/{holder_id}/accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/holders/{holder_id}/accounts"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/holders/{holder_id}/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "account": {
    "alias": "<string>",
    "assetCode": "<string>",
    "blocked": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "entityId": "<string>",
    "holderCheckSkipped": true,
    "holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parentAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": {
      "description": "<string>"
    },
    "type": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "metadata": {}
  },
  "instrument": {
    "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>"
  },
  "instrumentError": {
    "reason": "<string>",
    "status": "<string>"
  }
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

POST

organizations

{organization_id}

ledgers

{ledger_id}

holders

{holder_id}

accounts

Open a holder-owned account (with optional instrument)

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/holders/{holder_id}/accounts

const options = {method: 'POST'};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/holders/{holder_id}/accounts', 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}/ledgers/{ledger_id}/holders/{holder_id}/accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/holders/{holder_id}/accounts"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/holders/{holder_id}/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

{
  "account": {
    "alias": "<string>",
    "assetCode": "<string>",
    "blocked": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "entityId": "<string>",
    "holderCheckSkipped": true,
    "holderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parentAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": {
      "description": "<string>"
    },
    "type": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "metadata": {}
  },
  "instrument": {
    "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>"
  },
  "instrumentError": {
    "reason": "<string>",
    "status": "<string>"
  }
}

{
  "code": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "about:blank"
}

Headers

Content-Type

string

The type of media of the resource. Recommended value is application/json.

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.

ledger_id

string<uuid>

required

The unique identifier of the associated Ledger.

holder_id

string

required

Holder ID (UUID)

Response

account

object

required

Show child attributes

instrument

object

required

Show child attributes

instrumentError

object

Show child attributes

⌘I

Getting started

Organizations API

Ledgers API

Assets API

Account Types API

Accounts API

Portfolios API

Segments API

Balances API

Transactions API

Operations API

Operation Routes API

Transaction Routes API

Metadata Indexes API

Holders API

Instruments API

Billing Packages API

Packages API

Billing Calculation API

Estimation API

Encryption API

Protection API

Asset Rates API

Error handling

Fees Engine

Open a holder-owned account (with optional instrument)

Headers

Path Parameters

Response