Retrieve a user

Get information about a specific user.

Each user you create has a unique ID assigned to them. Use the following endpoint to retrieve information about a specific user, using the userId. The userId is available in the response body when you create a user.

📘

Additionally, you can retrieve the userId, from the Get All Users Endpoint.

Learn how to retrieve all your users.

Request Endpoint: reference

GET /api/users/{userId}

Parameter	Param Type	Description	Data Type	Mandatory
`userId`	Path	The `ID` of the user whose information you want to fetch	String	✅

Response Body:

{
  "success": true,
  "result": {
    "id": "9b4414c7-d033-4cba-9635-a535d31d7030",
    "reference": "USER-A",
    "createdAt": "2023-08-03T14:23:16.037191",
    "signingMethods": [
      {
        "id": "3355c892-31af-4260-87a3-a68175bcfea5",
        "type": "PIN",
        "incorrectAttempts": 0,
        "remainingAttempts": 10,
        "lastUsedSuccess": "2023-08-04T12:34:36.752094",
        "hasMasterSecret": true
      },
      {
        "id": "38ee7ad2-043d-4c38-9b5b-b962d23e7c8e",
        "type": "EMERGENCY_CODE",
        "incorrectAttempts": 0,
        "remainingAttempts": 10,
        "hasMasterSecret": true
      }
    ]
  }
}

Updated 8 months ago

Did this page help you?