API Reference

Create a user

posthttps://api.circle.com/v1/w3s/users

Reference
Playground

Create a user.

Body parameters

userId

string

Required

Unique system generated identifier for the user.

Response

201UserResponse

Response Body

object

data

object

Required

Show 7 properties

string

System-generated unique identifier of the resource.

createDate

string

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

pinStatus

string

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

Allowed valuesENABLEDUNSETLOCKED

status

string

Allowed valuesENABLEDDISABLED

securityQuestionStatus

string

Allowed valuesENABLEDUNSETLOCKED

pinDetails

object

Show 4 properties

failedAttempts

integer

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

lockedDate

string

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

lockedExpiryDate

string

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

lastLockOverrideDate

string

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

securityQuestionDetails

object

Show 4 properties

failedAttempts

integer

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

lockedDate

string

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

lockedExpiryDate

string

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

lastLockOverrideDate

string

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

400BadRequestResponse

401NotAuthorizedResponse

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
4    "createDate": "2023-01-01T12:04:05Z",
5    "pinStatus": "ENABLED",
6    "status": "ENABLED",
7    "securityQuestionStatus": "ENABLED",
8    "pinDetails": {
9      "failedAttempts": 0,
10      "lockedDate": "2023-01-01T12:04:05Z",
11      "lockedExpiryDate": "2023-01-01T12:04:05Z",
12      "lastLockOverrideDate": "2023-01-01T12:04:05Z"
13    },
14    "securityQuestionDetails": {
15      "failedAttempts": 0,
16      "lockedDate": "2023-01-01T12:04:05Z",
17      "lockedExpiryDate": "2023-01-01T12:04:05Z",
18      "lastLockOverrideDate": "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