We refreshed our doc site!

Bookmarked links may have changed

Read release notes

getUserByToken

Web3 Services
Compliance Engine

Get user status

GEThttps://api.circle.com/v1/w3s/user

Get user's PIN and Security Question statuses.

Header parameters
X-User-Token
string
Required

Unique system generated JWT session token for specific user.

Response
RequestChoose a language
ResponseChoose an example
1{
2  "data": {
3    "user": {
4      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
5      "createDate": "2023-01-01T12:04:05Z",
6      "pinStatus": "ENABLED",
7      "status": "ENABLED",
8      "securityQuestionStatus": "ENABLED",
9      "pinDetails": {
10        "failedAttempts": 0,
11        "lockedDate": "",
12        "lockedExpiryDate": "",
13        "lastLockOverrideDate": ""
14      },
15      "securityQuestionDetails": {
16        "failedAttempts": 0,
17        "lockedDate": "",
18        "lockedExpiryDate": "",
19        "lastLockOverrideDate": ""
20      }
21    }
22  }
23}
Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.