Skip to main content
POST
/
custody-commissions
Create Custody Commission
curl --request POST \
  --url https://api.example.com/custody-commissions \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "commission123",
  "registeredConsumers": [
    "consumer1",
    "consumer2"
  ]
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "identifier": "commission123",
  "registeredConsumers": [
    "consumer1",
    "consumer2"
  ],
  "createdAt": "2024-03-20T12:00:00Z",
  "updatedAt": "2024-03-20T12:00:00Z"
}

Body

application/json
​
identifier
string
required

The unique identifier for this commission

Example:

"commission123"

​
registeredConsumers
string[]

List of registered consumer IDs

Example:
["consumer1", "consumer2"]

Response

The custody commission has been successfully created

​
id
string
required

The unique identifier of the custody commission

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
identifier
string
required

The unique identifier for this commission

Example:

"commission123"

​
registeredConsumers
string[]
required

List of registered consumer IDs

Example:
["consumer1", "consumer2"]
​
createdAt
string<date-time>
required

When the custody commission was created

Example:

"2024-03-20T12:00:00Z"

​
updatedAt
string<date-time>
required

When the custody commission was last updated

Example:

"2024-03-20T12:00:00Z"