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

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

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Example:

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

Path Parameters

​
id
string<uuid>
required

The universally unique identifier of the resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Response

Successfully retrieved the challenge.

​
data
object
required