create_user | Circle

SDK Explorer

Getting Started

create_userPython,latest

Go to PyPI

Create a user.

Parameters

CreateUserRequest

object

Required

Show 1 properties

user_id

string

Required

Unique system generated identifier for the user.

Responses

201UserResponse

Response Body

object

data

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

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.PINAuthenticationApi(client)
7request = user_controlled_wallets.CreateUserRequest.from_dict({
8    "userId": "kakarot",
9})
10response = api_instance.create_user(create_user_request=request)
11print(response.json())
12

ResponseChoose an example

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

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy