API Reference

Learn how to access UNLOQ end points

POST /token

Returns the associated user data of a previously generated access token. Once an access token is generated, it is available only once and expires after 1 minute.

POST https://api.unloq.io/v1/token
Headers:
   Authorization: Bearer {your application API Key}
   Content-Type: application/json
Body Parameters
  • token (string, required) - previously user-generated authentication token
  • sid (string) - The session ID, generated by your application for the authenticated user. This is used for remote logout only, max 128 chars
  • duration (integer) - The number of seconds the session is considered active, before UNLOQ will consider it terminated.
  • ip (IP) - Optional. The originating IP address that will be displayed on the user's device.
  • temporary_keys (boolean) - Optional. Default is false.
Result format (200 OK)
{
  "type": "api.application.approval.token",
  "result": {
    "approval_id": "123456-123456-1234",
    "unloq_id": "1234",
    "email": "john@doe.com",
    "encryption_key": "123456asdf",
    "ip_source": "1.2.3.4",
    "method": "UNLOQ",
    "first_name": "John",
    "last_name": "Doe",
    "image": "https://img.jpg",
    "token_type": "AUTHENTICATE"
  }
}

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.