Get the entries of a holder registry

GET

https://api.t-dx.com/api/rest/v1/holder-registries/:registryId/entries

GET

/api/rest/v1/holder-registries/:registryId/entries

curl -G https://api.t-dx.com/api/rest/v1/holder-registries/registryId/entries \
     -H "Authorization: Bearer <token>" \
     -d cursor=eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ \
     -d query=VerificationStatus

{
  "result": [
    {
      "id": "29da2ce3-c2d8-4a13-b225-ce9e90ff5224",
      "holderRegistryId": "29da2ce3-c2d8-4a13-b225-ce9e90ff5224",
      "clientAccountId": "29da2ce3-c2d8-4a13-b225-ce9e90ff5224",
      "balance": "string",
      "name": "John Smith",
      "country": "CH",
      "nationalities": [
        "FR"
      ],
      "digitalAddress": "string",
      "entryType": "ENTRY_TYPE_CORE",
      "investorId": "29da2ce3-c2d8-4a13-b225-ce9e90ff5224",
      "status": "INVESTOR_ONBOARDING_STATUS_IN_PROGRESS",
      "deletedAt": "2024-01-15T09:30:00Z",
      "verificationStatus": "STATUS_VERIFIED",
      "IBAN": "CH5204835012345671000",
      "dateOfBirth": "2024-01-15T09:30:00Z",
      "email": "john.doe@somewhere.com",
      "address": "rue de la gare 12, Lausanne, CH",
      "phoneNumber": "+41 79 123 45 67",
      "sourceType": "HOLDING_SOURCE_TYPE_ISSUER",
      "holdingId": "29da2ce3-c2d8-4a13-b225-ce9e90ff5224"
    }
  ],
  "pagination": {
    "cursors": {
      "self": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "first": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "last": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "next": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ==",
      "previous": "eyJTb3J0cyI6W3siRmllbGQiOiJjcmVhdGVkX2F0IiwiVHlwZSI6ImRlc2MifV0sIkZpbHRlcnMiOltdLCJJc0ZpcnN0Ijp0cnVlfQ=="
    }
  },
  "sortingKeys": [
    {
      "key": "created_at-asc",
      "dir": "asc",
      "label": "key.deposits.sorts.created_at-asc",
      "fieldKey": "created_at"
    }
  ],
  "filters": [
    {
      "key": "instrument_id",
      "label": "key.deposits.filters.instrument_id",
      "range": {
        "min": "1",
        "max": "5000"
      },
      "values": [
        {
          "key": "STATUS_NEW",
          "label": "key.deposits.filters.status.fields.new"
        }
      ],
      "filterType": "FILTER_TYPE_VALUES",
      "valueType": "VALUE_TYPE_STRING"
    }
  ],
  "query": [
    "string"
  ]
}

This endpoint returns the entries of a holder registry.

Authentication

AuthorizationBearer

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

Path parameters

registryIdstringRequiredformat: "uuid"

ID of the holder registry

Query parameters

sortstringOptionalformat: "(created_at-asc|created_at-desc)"Defaults to created_at-asc

Optionally sort the results

limitstringOptionalformat: "uint64"Defaults to 20

Optionally limit the number of results (between 1 and 500)

querylist of stringsOptional

Optionally filter the results

cursorstringOptionalformat: "base64"

Optionally provide a cursor to paginate over pages of results

Response

A successful response.

resultlist of objectsOptional

paginationobjectOptional

sortingKeyslist of objectsOptional

filterslist of objectsOptional

querylist of stringsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error