get_user | Circle

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_userPython,latest

Go to PyPI

Get user by ID.

Parameters

string

Required

Filter by user's system generated identifiers.

x_request_id

string

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

Responses

200GetUserByIDResponse

Response Body

object

data

object

Required

Show 1 properties

user

object

Required

Show 7 properties

string

System-generated unique identifier of the resource.

create_date

string

Date and time the resource was created, in ISO-8601 UTC format.

pin_status

string

Status of the user PIN code. PIN must be in ENABLED state to authorize requests.

Allowed valuesENABLEDUNSETLOCKED

status

string

Allowed valuesENABLEDDISABLED

security_question_status

string

Allowed valuesENABLEDUNSETLOCKED

pin_details

object

Show 4 properties

failed_attempts

integer

FailedAttempts the number of times a user has entered an invalid pin code.

locked_date

string

The date and time when the pin code has been locked.

locked_expiry_date

string

The date and time when the pin code will be unlocked.

last_lock_override_date

string

This is the last date and time when the lock was unlocked by admin manually.

security_question_details

object

Show 4 properties

failed_attempts

integer

FailedAttempts the number of times a user has entered an invalid pin code.

locked_date

string

The date and time when the pin code has been locked.

locked_expiry_date

string

The date and time when the pin code will be unlocked.

last_lock_override_date

string

This is the last date and time when the lock was unlocked by admin manually.

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(id="kakarot")
9print(response.json())
10

ResponseChoose an example

1{
2  "data": {
3    "user": {
4      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5      "create_date": "2023-01-01T12:04:05Z",
6      "pin_status": "ENABLED",
7      "status": "ENABLED",
8      "security_question_status": "ENABLED",
9      "pin_details": {
10        "failed_attempts": 0,
11        "locked_date": "2023-01-01T12:04:05Z",
12        "locked_expiry_date": "2023-01-01T12:04:05Z",
13        "last_lock_override_date": "2023-01-01T12:04:05Z"
14      },
15      "security_question_details": {
16        "failed_attempts": 0,
17        "locked_date": "2023-01-01T12:04:05Z",
18        "locked_expiry_date": "2023-01-01T12:04:05Z",
19        "last_lock_override_date": "2023-01-01T12:04:05Z"
20      }
21    }
22  }
23}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy