Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Stablecoin

Create Compliance Request (Issuer)

Submits a freeze or unfreeze compliance request for an address.

post/api/stablecoin/v1/issuer/compliance-requests

Request body

addressstring required

Blockchain address targeted by this request

addressLabelstring required

Human-readable label for the targeted address — required for all new requests

type'freeze' | 'unfreeze' | 'pause' | 'unpause' required

Type of compliance operation

assetIdstring uuid required

Asset identifier

commentsstring

Optional notes about the request

Example request

{
  "address": "0xd0898d88e2c08b2a95e19441e412c0a708a8bd43",
  "addressLabel": "Hot Wallet A",
  "type": "freeze",
  "assetId": "0438163a-d236-4865-978e-02ee7c2285b7",
  "comments": "Suspicious activity detected"
}

Response

OK

idstring uuid required

Unique identifier for the compliance request

type'freeze' | 'unfreeze' | 'pause' | 'unpause' required

Type of compliance operation

status'created' | 'pending_approval' | 'approved' | 'confirmed' | 'rejected' | 'cancelled' | 'failed' required

Current lifecycle status

assetIdstring uuid required

ID of the asset this request applies to

enterpriseIdstring required

Enterprise ID of the requester

requestSource'issuer' | 'bitgo' required

Source that originated this compliance request; trust-initiated requests are surfaced as 'bitgo'

baseAsset'gousd' | 'usd1' | 'sofid' | 'cusd' | 'fyusd' | 'qxmp' | 'scaasacme' required

Base stablecoin symbol for the asset

chainstring required

Blockchain network for the asset

addressstring required

Blockchain address targeted by this request

addressLabelstring required

Human-readable label for the targeted address

createdAtstring date-time required

Timestamp when the request was created

updatedAtstring date-time required

Timestamp when the request was last updated

userIdstring

ID of the user who created the request; omitted when the maker is bitgo-source on issuer-facing responses

commentsstring

Optional notes about the request

pendingApprovalIdstring

Platform pending-approval ID, present after the request is submitted for approval

bitgoTransferIdstring

BitGo transfer ID, present after the transaction is broadcast

transactionHashstring

On-chain transaction hash, present after confirmation

Example response

{
  "id": "177dc9ed-64a7-4f68-9ba5-8d5b55fe5878",
  "type": "freeze",
  "status": "pending_approval",
  "assetId": "0438163a-d236-4865-978e-02ee7c2285b7",
  "enterpriseId": "6437d9f07d6a87000613e6c06e4218d3",
  "requestSource": "issuer",
  "baseAsset": "usd1",
  "chain": "eth",
  "address": "0xd0898d88e2c08b2a95e19441e412c0a708a8bd43",
  "addressLabel": "Hot Wallet A",
  "createdAt": "2025-06-23T07:28:17.042Z",
  "updatedAt": "2025-06-23T07:28:17.042Z",
  "userId": "6437d9f07d6a87000613e6c06e4218d3",
  "comments": "Suspicious activity detected",
  "pendingApprovalId": "pa_123",
  "bitgoTransferId": "6437d9f07d6a87000613e6c06e4218d3",
  "transactionHash": "0xabcdef1234567890",
  "complianceRequestHistory": [
    {
      "status": "pending_approval",
      "actorSource": "bitgo",
      "timestamp": "2025-06-23T07:28:17.042Z",
      "actorId": "6437d9f07d6a87000613e6c06e4218d3"
    }
  ]
}