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"
    }
  ],
  "totalItems": "string",
  "rulesContainers": [
    {
      "hash": "string",
      "rulesContainer": "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: "int64"

Return maximum limit items for a query; Max 100.

offsetstringOptionalformat: "int64"

Start retrieving items starting at offset id

idslist of stringsOptional

List of IDs to return

blockchainstringOptional

Filter on the blockchain of the WLA.

addressTypestringOptional

Can be one of the following: individual, exchange, baker, stakepool, contract, validator, node

querystringOptional

Will find a match in any part of the value. Filter applies to the following fields: customerid, address, blockchain, label, memo, addresstype

networkstringOptional

Name of the blockchain network, eg. mainnet, testnet, or sepolia

includeAlreadySignedByUserbooleanOptional

Set to true to not exclude the pending approval whitelist 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