Sign in
Mandates

Get a mandate approval

Changed on

Retrieves a single approval by its ID, including its current status, its onchainTransactions once submitted, and, when it failed, its error. Poll this after Approve a mandate with a wallet to follow a pending approval to succeeded or failed, or consume the mandate webhooks instead.

get/v2/mandates/{mandateId}/approvals/{approvalId}

Request

  • Base URL: https://api.cdp.coinbase.com/platform
  • URL: https://api.cdp.coinbase.com/platform/v2/mandates/{mandateId}/approvals/{approvalId}
  • Auth: HTTP bearer

Path parameters

mandateIdstring required

The ID of the mandate, a UUID prefixed by mandate_.

Example:mandate_82c879c1-84e1-44ed-a8c2-1ac239cf09ad

The unique identifier of the mandate.

approvalIdstring required

The ID of an approval, a UUID prefixed by approval_.

Example:approval_5f0e9d8c-7b6a-4321-fedc-ba0987654321

The unique identifier of the approval.

Response

Successfully retrieved mandate approval.

approvalIdstring required

The ID of an approval, a UUID prefixed by approval_.

status'pending' | 'succeeded' | 'failed' required

The status of an approval attempt:

  • pending: the submitted source is being bound and verified.

  • succeeded: the mandate's source is attached and its status becomes approval_succeeded.

  • failed: the attempt could not be completed (see error). The mandate's status becomes approval_failed; submit a new approval to retry (which moves it back to approval_pending).

metadataMetadata

Optional metadata as key-value pairs. Use this to store additional structured information on a resource, such as customer IDs, order references, or any application-specific data. Up to 10 key/value pairs may be provided. Keys and values are both strings. Keys must be ≤ 40 characters; values must be ≤ 500 characters.

createdAtstring date-time required

The UTC ISO 8601 timestamp at which the approval was created.

updatedAtstring date-time required

The UTC ISO 8601 timestamp at which the approval was last updated.

Example response

{
  "approvalId": "approval_5f0e9d8c-7b6a-4321-fedc-ba0987654321",
  "status": "succeeded",
  "source": {
    "address": "0xAbC1234567890aBcDeF1234567890AbCdEf123456",
    "network": "base",
    "asset": "usdc"
  },
  "onchainTransactions": [
    {
      "transactionHash": "0xabc123def456789012345678901234567890abcdef1234567890abcdef123456",
      "network": "base"
    }
  ],
  "createdAt": "2025-06-15T12:04:00.000Z",
  "updatedAt": "2025-06-15T12:05:00.000Z"
}

Changes