get_user_challenge

SDK Explorer

Developer Controlled Wallets

Getting Started

Methods Overview

Health

Webhook Subscriptions

Monitor Tokens

Developer Account

Faucet

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

get_user_challengePython,latest

Go to PyPI

Retrieve a user challenge.

Parameters

string

Required

ExtChallenge id to query

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.

Responses

200ChallengeResponse

Response Body

object

data

object

Required

Show 1 properties

challenge

object

Required

Show 6 properties

string

Required

System-generated unique identifier of the resource.

correlation_ids

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.

error_code

integer

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

error_message

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

Example

1from circle.web3 import user_controlled_wallets
2from circle.web3 import utils
3
4client = utils.init_user_controlled_wallets_client(api_key=key)
5
6api_instance = user_controlled_wallets.UsersApi(client)
7
8response = api_instance.get_user_challenge(x_user_token=user_token, id="f431596f-f12a-4e4a-bedb-93694db5186e")
9print(response.json())
10

ResponseChoose an example

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

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy