List shareholders

GET

https://your-protect-instance.example.com/api/rest/v1/capital/shareholders

GET

/api/rest/v1/capital/shareholders

curl https://your-protect-instance.example.com/api/rest/v1/capital/shareholders \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "result": {
    "shareholders": [
      {
        "id": "string",
        "digitalAssetID": "string",
        "addressID": "string",
        "investorID": "string",
        "investorName": "string",
        "ref": "string",
        "numberOfShares": "string",
        "nominalValuePerShare": 1.1,
        "currency": "string",
        "comments": "string",
        "ownershipProof": true,
        "parentID": "string",
        "idProofAttachment": {
          "id": "string",
          "key": "string",
          "filename": "string",
          "contentType": "string",
          "location": "string",
          "documentCategory": "string",
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        },
        "digitalAssetAddress": "string",
        "tokenizeStatus": "string"
      }
    ],
    "totalItems": "string"
  }
}

This endpoint returns a list of shareholders

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitstringOptionalformat: "uint64"

offsetstringOptionalformat: "uint64"

sort.orderstringOptional

sort.typestringOptional

digitalAssetIDstringOptionalformat: "uint64"

digitalAssetAddressIDstringOptionalformat: "uint64"

Response

A successful response.

resultobjectOptional