Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Enterprise

List enterprise users

get/api/v1/enterprise/{enterpriseId}/user

Path parameters

enterpriseIdstring required
Example:59cd72485007a239fb00282ed480da1f

The enterprise ID

Query parameters

allowInactiveUsersboolean

Whether inactive Users whose emails are unverified should be returned as well

Response

OK

countinteger

The total number of Users returned.

incompleteboolean

Set to true if the Enterprise has at least 500 v1 or v2 wallets. If there are more than 500 wallets (either v1 or v2) it could mean that some Wallets were not considered for finding all Users.

Example response

{
  "adminUsers": [
    {
      "id": "59cd72485007a239fb00282ed480da1f",
      "username": "user@example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "fullName": "Jane Doe",
      "email": {
        "email": "user@example.com"
      },
      "identity": {
        "kyc": {
          "hasVideoID": true,
          "required": true
        }
      }
    }
  ],
  "nonAdminUsers": [
    {
      "id": "59cd72485007a239fb00282ed480da1f",
      "username": "user@example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "fullName": "Jane Doe",
      "email": {
        "email": "user@example.com"
      },
      "identity": {
        "kyc": {
          "hasVideoID": true,
          "required": true
        }
      }
    }
  ]
}