Documentation Hub
Mobile SDK
Mobile SDK
  • Keyless SDK Documentation
  • Introduction
    • 🧩Components
    • ⚙️Integration Flows
    • 🤳Sample Apps
  • 📱Mobile SDK Guide
    • 1️⃣ Getting started
    • 2️⃣ Enrollment
    • 3️⃣ Authentication
    • 4️⃣ De-Enrollment
    • 5️⃣ Backup
    • 6️⃣ User and device management
  • 📱Mobile SDK Reference
    • UI Customization
    • Error handling
    • Liveness Settings
    • JWT signing
    • PIN authentication
    • Introduce Keyless to Users
    • Photo Enrollment
  • 📱Mobile SDK Use Cases
    • Account recovery
    • Dynamic Linking
  • 📒Mobile SDK Changelog
    • Changelog
  • 💽Server API
    • Getting Started
    • Users
    • Devices
    • Operations
Powered by GitBook
On this page

Was this helpful?

  1. Server API

Devices

This set of API calls allows you to fetch and manipulate Keyless enabled devices.

Last updated 1 year ago

Was this helpful?

💽

Get user devices

get

Get user devices

Authorizations
Path parameters
userIdstring · Uppercase HEX stringRequired

The user id

Responses
200
User devices
application/json
400
Request is invalid and shouldn't be retried if the request is unchanged
application/json
401
Unauthorized request, the request can't be processed unless you provide a valid authentication method
application/json
404
Resource not found
application/json
406
Not acceptable representation
application/json
500
An internal error occurred, please try again later or contact the support.
application/json
get
GET /v2/users/{userId}/devices HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*
[
  {
    "userId": "0123456789ABCDEF",
    "sdkCustomerId": 1,
    "publicSigningKey": "text",
    "publicEncryptionKey": "text",
    "state": "ACTIVE",
    "createdAt": "2020-01-02T03:04:05.242194378",
    "osVersion": "text",
    "sdkVersion": "text",
    "deletedAt": "2020-01-02T03:04:05.242194378"
  }
]

Delete user device

delete

Delete user device

Authorizations
Path parameters
userIdstring · Uppercase HEX stringRequired

The user id

publicSigningKeystringRequired

Public signing key

Responses
200
Device successfully deleted
application/json
400
Request is invalid and shouldn't be retried if the request is unchanged
application/json
401
Unauthorized request, the request can't be processed unless you provide a valid authentication method
application/json
404
Resource not found
application/json
406
Not acceptable representation
application/json
500
An internal error occurred, please try again later or contact the support.
application/json
delete
DELETE /v2/users/{userId}/devices/{publicSigningKey} HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*
{
  "success": true
}
  • GETGet user devices
  • DELETEDelete user device