Skip to main content
GET
/
v1
/
w3s
/
user
/
challenges
List challenges
curl --request GET \
  --url https://api.circle.com/v1/w3s/user/challenges \
  --header 'Authorization: Bearer <token>' \
  --header 'X-User-Token: <x-user-token>'
{
  "data": {
    "challenges": [
      {
        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
        "status": "PENDING",
        "type": "SET_PIN",
        "correlationIds": [
          "54399e5a-1bf6-4921-9559-10c1115678cd"
        ],
        "errorCode": 155121,
        "errorMessage": "challenge expired"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Headers

​
X-User-Token
string
required

Unique system generated JWT session token for specific user.

​
X-Request-Id
string<uuid>

Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. Must be a UUID to appear in logs. Non-UUID values are accepted by the API but are ignored by logging and tracing systems.

A unique identifier, which can be helpful for identifying a request when communicating with Circle support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Query Parameters

​
status
enum<string>

Filter by external challenge status.

Available options:
PENDING,
IN_PROGRESS

Response

Successfully retrieved the challenges.

​
data
object
required