API Reference

Learn how to access UNLOQ end points

GET /enrolled

Checks if the given e-mail address is enrolled with the application's two-factor authentication.

GET https://api-authenticator.iwelcome.com/v1/enrolled
   Authorization: Bearer {your application API Key}
   Content-Type: application/json
Query parameters
  • email (string, required) - The e-mail address of the user's profile
Result format (200 OK)
   "type": "api.application.enroll.check",
   "result": {
    "enrolled": true
Error format (4xx)
   "error": {
    "code": "{e.code}",
    "ns": "{e.ns}",
    "message": "{e.message}",
    "status": "{e.statusCode}"

The result will contain enrolled=true if the following conditions apply:
- a profile exists with the specified e-mail and
  - the profile is verified and has a device attached or
  - the profile is virtual and is enrolled and has a device attached.

Have a question? You can always send us an email at support@unloq.io, or contact us on chat.

For security related concerns, please visit our Security page.