List whitelisted addresses for approval

GET

https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses/for-approval

GET

/api/rest/v1/whitelists/addresses/for-approval

curl https://your-protect-instance.example.com/api/rest/v1/whitelists/addresses/for-approval \
     -H "Authorization: Bearer <token>"

{
  "result": [
    {
      "id": "string",
      "tenantId": "string",
      "signedAddress": {
        "signatures": [
          {
            "signature": {
              "userId": "string",
              "signature": "string",
              "comment": "string"
            },
            "hashes": [
              "string"
            ]
          }
        ],
        "payload": "string"
      },
      "metadata": {
        "hash": "string",
        "payloadAsString": "string"
      },
      "action": "string",
      "scores": [
        {
          "id": "string",
          "provider": "string",
          "type": "string",
          "score": "string",
          "updateDate": "2024-01-15T09:30:00Z"
        }
      ],
      "trails": [
        {
          "id": "string",
          "userId": "string",
          "externalUserId": "string",
          "action": "string",
          "comment": "string",
          "date": "2024-01-15T09:30:00Z"
        }
      ],
      "rulesContainer": "string",
      "rule": "string",
      "approvers": {
        "parallel": [
          {
            "sequential": [
              {
                "externalGroupID": "string",
                "minimumSignatures": 1
              }
            ]
          }
        ]
      },
      "attributes": [
        {
          "id": "string",
          "key": "string",
          "value": "string",
          "contentType": "string",
          "owner": "string",
          "type": "string",
          "subtype": "string",
          "isfile": true
        }
      ],
      "rulesContainerHash": "string",
      "blockchain": "string",
      "status": "string",
      "network": "string",
      "visibilityGroupID": "string",
      "tnParticipantID": "string",
      "rulesSignatures": "string"
    }
  ],
  "totalItems": "string",
  "rulesContainers": [
    {
      "hash": "string",
      "rulesContainer": "string",
      "rulesSignatures": "string"
    }
  ]
}

This endpoint returns a list of whitelisted addresses for approval

Authentication

AuthorizationBearer

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

Query parameters

limitstringOptionalformat: "uint64"

uint64; The amount of unapproved whitelisted address returned per request. Max 100.

offsetstringOptionalformat: "uint64"

uint64; The offset from which to begin selection of unapproved whitelisted addresses.

idslist of stringsOptional

uint64 Array; The ids to filter your requests selection by.

blockchainstringOptional

The blockchain associated with the unapproved whitelisted addresses. (ex. eth, btc)

addressTypestringOptional

The type of unapproved whitelisted address (ex. individual, exchange, baker, contract, stakepool, validator, node, fiatprovider).

querystringOptional

A search query to filter your request with. Will search the label or address fields.

networkstringOptional

The network of the associated blockchain the address is in. (ex. mainnet, sepolia)

includeAlreadySignedByUserbooleanOptional

Set to true to include the pending approval whitelisted addresses already signed by the user. Default: false

Response

A successful response.

resultlist of objectsOptional

totalItemsstringOptionalformat: "uint64"

rulesContainerslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error