SDK Explorer

Creates a new user.

Parameters
input
object
Required

Represents the input parameters for creating a user.

userId
string
Required

The unique identifier generated by your system for the user.

Responses
Example
1const response = await client.createUser({
2  userId: 'user-id',
3})
4console.log(response.status)
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?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.