REST API›Mint›Stablecoin

PATCH

Cancel Compliance Request (Issuer)

Cancels an active compliance request. Only requests in created or pending_approval status may be cancelled. If a pending approval exists in the Wallet Platform it is rejected as part of the cancellation.

Path Params

  • id string uuid required
    Compliance request identifier

Responses

200
OK

Response Body

object

Detail-view shape — extends ComplianceRequestSummary with the full audit trail.
  • id string uuid required
    Unique identifier for the compliance request

    at least 1 characters

  • type string enum required
    Type of compliance operation
    freezeunfreeze
  • status string enum required
    Current lifecycle status
    createdpending_approvalapprovedconfirmedrejectedcancelledfailed
  • assetId string uuid required
    ID of the asset this request applies to

    at least 1 characters

  • enterpriseId string required
    Enterprise ID of the requester

    at least 1 characters

  • requestSource string enum required
    Source that originated this compliance request; trust-initiated requests are surfaced as 'bitgo'
    issuerbitgo
  • baseAsset string enum required
    Base stablecoin symbol for the asset
    gousdusd1sofidcusdfyusdqxmpscaasacme
  • chain string required
    Blockchain network for the asset

    at least 1 characters

  • address string required
    Blockchain address targeted by this request

    at least 1 characters

  • addressLabel string required
    Human-readable label for the targeted address

    at least 1 characters

  • createdAt string date-time required
    Timestamp when the request was created
  • updatedAt string date-time required
    Timestamp when the request was last updated
  • userId string
    ID of the user who created the request; omitted when the maker is bitgo-source on issuer-facing responses

    at least 1 characters

  • comments string
    Optional notes about the request

    at least 1 characters

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

    at least 1 characters

  • bitgoTransferId string
    BitGo transfer ID, present after the transaction is broadcast

    at least 1 characters

  • transactionHash string
    On-chain transaction hash, present after confirmation

    at least 1 characters

  • complianceRequestHistory array of objects required
    complianceRequestHistory object
    • status string enum required
      Lifecycle status at the time of this history event
      createdpending_approvalapprovedconfirmedrejectedcancelledfailed
    • actorSource string enum required
      Source that performed this action; trust-initiated actions are surfaced as 'bitgo'
      issuerbitgosystem
    • timestamp string date-time required
      Timestamp when this transition occurred
    • actorId string
      ID of the user who performed the action; omitted for system entries and masked for bitgo entries on issuer-facing responses

      at least 1 characters

400
Bad Request
No response body
401
Unauthorized
No response body
403
Forbidden
No response body
404
Not Found
No response body
409
Conflict
No response body
500
Internal Server Error
No response body