getUserChallenge

Web3 Services

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Smart Contract Platform

Templates

View / Update

Interact

Deploy / Import

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

Get a challenge

GEThttps://api.circle.com/v1/w3s/user/challenges/{id}

Get the status of a challenge.

Header parameters

X-User-Token

string

Required

Unique system generated JWT session token for specific user.

Path parameters

uuid

Required

ExtChallenge id to query

Response

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.

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

type

string

Required

The challenge type

defaultError

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "challenge": {
4      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5      "correlationIds": [],
6      "errorCode": 155121,
7      "errorMessage": "challenge expired",
8      "status": "PENDING",
9      "type": "SET_PIN"
10    }
11  }
12}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy