Ownership Changes

get

Get a paginated list of ownership changes information in the system

Query parameters
account_addressstringOptional

Filter ownership changes by account address, unique for this gateway

Pattern: r[0-9a-zA-Z]{24,34}
bond_idstring · uuidOptional

Filter ownership changes by bond id, unique for this gateway

Example: f1531e0b-90f9-4174-a772-498c3f20ebca
Responses
200

Successfully retrieved a list of items.

application/json
Responseall of
get
/ownership-changes
GET /ownership-changes HTTP/1.1
Host: 
Accept: */*
200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z",
      "id": "2c2155d2-c78a-4a28-a4bd-b2fb4d207ddd",
      "asset_id": "c5e24692-0fc9-4abc-9328-ea2cd876e6bb",
      "amount": 10,
      "source_account_address": "text",
      "destination_account_address": "text",
      "status": "created",
      "description": "Assets were confiscated",
      "message": "Court order has been retracted",
      "cancelled_by_account_address": {},
      "expires_at": "2025-10-12T13:47:37.550Z"
    }
  ]
}
post

Initiates an asset ownership change between accounts

Body
asset_idstring · uuidRequired

Asset identifier to be transferred ,unique to this gateway

Example: f4f60855-342e-4005-8dfd-f5ef7f605ec3
source_account_addressstringRequired

Source account address

Pattern: r[0-9a-zA-Z]{24,34}
destination_account_addressstringRequired

Destination account address

Pattern: r[0-9a-zA-Z]{24,34}
amountinteger · int64Required

Amount of tokens to transfer ownership of

Example: 1000
descriptionstringOptional

Optional description of why this transfer was initiated

Example: Transferring to family as instructed in will
expires_atstring · date-timeOptional

Timestamp in the future when this transfer proposal will be available

Example: 2025-10-19T13:47:37.549Z
Responses
201

Created ownership change

application/json
post
/ownership-changes
POST /ownership-changes HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "asset_id": "f4f60855-342e-4005-8dfd-f5ef7f605ec3",
  "source_account_address": "text",
  "destination_account_address": "text",
  "amount": 1000,
  "description": "Transferring to family as instructed in will",
  "expires_at": "2025-10-19T13:47:37.549Z"
}
201

Created ownership change

{
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z",
  "id": "2c2155d2-c78a-4a28-a4bd-b2fb4d207ddd",
  "asset_id": "c5e24692-0fc9-4abc-9328-ea2cd876e6bb",
  "amount": 10,
  "source_account_address": "text",
  "destination_account_address": "text",
  "status": "created",
  "description": "Assets were confiscated",
  "message": "Court order has been retracted",
  "cancelled_by_account_address": {},
  "expires_at": "2025-10-12T13:47:37.550Z"
}
patch

Accept or cancel ownershipChange

Path parameters
ownershipChangeIdstringRequired
Body
statusstring · enumRequired

Status to change ownership change to

Example: acceptedPossible values:
account_addressstringRequired

Address of a sender or receiver account, on whose behalf this change action is performed. (Receiver address for accepting)

Pattern: r[0-9a-zA-Z]{24,34}
messagestringOptional

An optional message that will be attached to ownership change on cancellation

Example: Investor has been informed and declined ownership of these assets
Responses
200Success
No content
patch
/ownership-changes/{ownershipChangeId}
PATCH /ownership-changes/{ownershipChangeId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "status": "accepted",
  "account_address": "text",
  "message": "Investor has been informed and declined ownership of these assets"
}
200Success
No content
PreviousOTC Trades FOPNextTrades