Skip to main content
POST
/
v1
/
w3s
/
users
Create a user
curl --request POST \
  --url https://api.circle.com/v1/w3s/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "ext_user_id_1"
}
'
{
  "data": {
    "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
    "createDate": "2023-01-01T12:04:05Z",
    "pinStatus": "ENABLED",
    "status": "ENABLED",
    "securityQuestionStatus": "ENABLED",
    "pinDetails": {
      "failedAttempts": 123,
      "lockedDate": "2023-01-01T12:04:05Z",
      "lockedExpiryDate": "2023-01-01T12:04:05Z",
      "lastLockOverrideDate": "2023-01-01T12:04:05Z"
    },
    "securityQuestionDetails": {
      "failedAttempts": 123,
      "lockedDate": "2023-01-01T12:04:05Z",
      "lockedExpiryDate": "2023-01-01T12:04:05Z",
      "lastLockOverrideDate": "2023-01-01T12:04:05Z"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.circle.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are required to make a successful request.

Body

application/json

Request body

​
userId
string
required

Unique system generated identifier for the user.

Required string length: 5 - 50
Example:

"ext_user_id_1"

Response

User creation successful.

​
data
object
required