API Reference

List challenges

gethttps://api.circle.com/v1/w3s/user/challenges

Reference
Playground

List all challenges by status for a user.

Header parameters

X-User-Token

string

Required

Unique system generated JWT session token for specific user.

Query parameters

status

string

Filter by external challenge status.

Response

200ChallengesResponse

Response Body

object

data

object

Required

Show 1 properties

challenges

array of objects

Show 6 properties

string

Required

System-generated unique identifier of the resource.

correlationIds

array of strings

For type CREATE_WALLET, the wallet id associated with the request. For types CREATE_TRANSACTION, ACCELERATE_TRANSACTION, and CANCEL_TRANSACTION, the transaction id associated with the request.

errorCode

integer

Indicates the failure reason of a challenge. Only present for challenges in FAILED status.

errorMessage

string

Description of the error or error reason. Only present for challenges in FAILED status.

status

string

Required

Allowed valuesPENDINGIN_PROGRESSCOMPLETEFAILEDEXPIRED

type

string

Required

The challenge type

Allowed valuesINITIALIZESET_PINCHANGE_PINSET_SECURITY_QUESTIONSCREATE_WALLETRESTORE_PINCREATE_TRANSACTIONACCELERATE_TRANSACTIONCANCEL_TRANSACTIONCONTRACT_EXECUTIONWALLET_UPGRADESIGN_MESSAGESIGN_TYPEDDATASIGN_TRANSACTION

400BadRequestResponse

401NotAuthorizedResponse

404NotFoundResponse

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "challenges": [
4      {
5        "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
6        "correlationIds": [
7          "54399e5a-1bf6-4921-9559-10c1115678cd"
8        ],
9        "errorCode": 155121,
10        "errorMessage": "challenge expired",
11        "status": "PENDING",
12        "type": "SET_PIN"
13      }
14    ]
15  }
16}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy