Skip to main content

Module user

Module user 

Source
Expand description

User resource models for the Circle User-Controlled Wallets API.

Contains request parameters and response types for user registration and management endpoints.

Structs§

CreateUserRequest
Request body for createUser.
EndUser
An end-user record returned by the Circle API.
GetUserByIdData
Inner data payload for getUserById.
GetUserByIdResponse
Response envelope for getUser (by ID).
GetUserTokenRequest
Request body for getUserToken.
ListUsersParams
Query parameters for listUsers.
PinSecurityDetails
PIN security details for an end-user.
UserResponse
Response envelope for the getUserByToken endpoint.
UserTokenData
Payload inside a userToken response.
UserTokenResponse
Response envelope for getUserToken.
Users
Response envelope for list-users.
UsersData
data payload for list-users responses.

Enums§

EndUserStatus
Overall account status of an end-user.
PinStatus
PIN status for an end-user.
SecurityQuestionStatus
Status of security question recovery for an end-user.