Skip to main content
POST
/
v1
/
ledger
Create a new ledger
curl --request POST \
  --url https://api.sandbox.nxos.io/v1/ledger \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ledger_ref": "<string>",
  "metadata": {}
}
'
{
  "ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledger_ref": "<string>",
  "metadata": {}
}

Headers

​
Authorization
string
required

The Basic Authentication header. Format: "Basic {base64(orgID:apiKey)}"

Body

application/json
​
ledger_ref
string
required
Minimum string length: 1
​
metadata
object

Additional, optional, metadata for the ledger

Response

200 - application/json

The request has succeeded.

​
ledger_id
string<uuid>
required

The unique identifier of the ledger

​
ledger_ref
string
required

The externally defined reference of the ledger

​
metadata
object

Additional, optional, metadata for the ledger