Ctrl+K

Get Blacklist Address List

get/api/stablecoin/v1/admin/blacklist/addresses

Retrieves a list of blacklisted addresses.

Query Parameters

  • idsarray[string]<uuid>
    Blacklist entry identifiers
    Example: 177dc9ed-64a7-4f68-9ba5-8d5b55fe5878
    Min length: >= 1 characters
  • addressesarray[string]
    Blockchain addresses
    Example: 0xd0898d88e2c08b2a95e19441e412c0a708a8bd43
    Min length: >= 1 characters
  • assetIdstring<uuid>
    Asset identifier
    Example: 0438163a-d236-4865-978e-02ee7c2285b7
    Min length: >= 1 characters
  • createdBystring
    Creator email
    Example: user@bitgo.com
    Min length: >= 1 characters
  • txHashstring
    Transaction hash
    Example: 54db949e15d93b47e3e3a7bd2524e628
    Min length: >= 1 characters
  • isBlacklistedboolean
    Blacklist status
    Example:
  • updatedBystring
    Last updater email
    Example: user@bitgo.com
    Min length: >= 1 characters
  • skipstring<number>
    Number of entries to skip in pagination
  • limitstring<number>
    Maximum number of entries to return
  • sortBystring
    Field name for sorting results
    Min length: >= 1 characters
  • sortOrderstring
    Direction of sort (asc/desc)
    Min length: >= 1 characters

200 Response

addresses array[object] required
List of blacklisted addresses
id string <uuid>required
Unique identifier for the blacklist entry
Min length: >= 1 characters
Example: 177dc9ed-64a7-4f68-9ba5-8d5b55fe5878
address string required
Blockchain address that is blacklisted
Min length: >= 1 characters
Example: 0xd0898d88e2c08b2a95e19441e412c0a708a8bd43
assetId string required
ID of the asset this blacklist entry applies to
Min length: >= 1 characters
Example: 0438163a-d236-4865-978e-02ee7c2285b7
txHash string required
Transaction hash associated with the blacklist entry
Min length: >= 1 characters
Example: 54db949e15d93b47e3e3a7bd2524e628
isBlacklisted boolean required
Flag indicating if address is currently blacklisted
Example: true
comment string required
Additional information about the blacklist entry
Min length: >= 1 characters
Example: comment
createdBy string required
User who created the blacklist entry
Min length: >= 1 characters
Example: 6437d9f07d6a87000613e6c06e4218d3
updatedBy string required
User who last updated the blacklist entry
Min length: >= 1 characters
Example: 6437d9f07d6a87000613e6c06e4218d3
transactions array[object]
List of transactions associated with this blacklist entry

400 Response

500 Response