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
  • 📱Mobile SDK Use Cases
    • Account recovery
    • Dynamic Linking
    • Authenticating in Auth0 with Keyless
  • 📒Mobile SDK Changelog
    • Changelog
  • 💽Server API
    • Getting Started
    • Users
    • Devices
    • Operations
Powered by GitBook
On this page

Was this helpful?

  1. Server API

Operations

This set of API calls allows you to fetch operations on various Keyless entities.

Last updated 4 months ago

Was this helpful?

Operations

JWT

💽

Get a user's pending operations

get

Get a user's pending operations

Authorizations
Path parameters
userIdstring · Uppercase HEX stringRequired

The user id

Responses
200
An user's pending operations
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}/operations/pending HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*
[
  {
    "operationId": "123456abcdef",
    "operationPayload": "payload",
    "externalUserId": "abcdef123456",
    "authType": "biom"
  },
  {
    "operationId": "654321fedcba"
  }
]

Get a customer operation

get

Get a customer operation

Authorizations
Path parameters
operationIdstringRequired

Unique operation identifier set and managed by the client

Responses
200
A customer operation
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/operations/{operationId} HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*
{
  "id": 1,
  "timestamp": "2020-01-02T03:04:05.68",
  "nodeId": "text",
  "userId": "0123456789ABCDEF",
  "apiKey": "text",
  "externalUserId": "text",
  "operationId": "text",
  "operationPayload": "text",
  "result": true,
  "authType": "biom",
  "state": "approved"
}

Get the customer public key

get

Get the customer public key in PEM format

Authorizations
Responses
200
The public key in PEM format
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
406
Not acceptable representation
application/json
get
GET /v2/verify-jwt/public-key HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*
{
  "content": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwJ1\n-----END PUBLIC KEY-----"
}
  • Operations
  • GETGet a user's pending operations
  • GETGet a customer operation
  • POSTCreate a pending operation
  • JWT
  • GETGet the customer public key
  • POSTVerify a signed JWT message

Create a pending operation

post

Create a pending operation

Authorizations
Path parameters
userIdstring · Uppercase HEX stringRequired

The user id

Body
externalUserIdstringOptional

User id set and managed by the client

operationIdstringRequired

Unique operation identifier set and managed by the client

operationPayloadstringOptional

Operation payload set and managed by the client

Responses
200
Operation created successfully
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
409
The requested operation conflicts with the current state of the server
application/json
415
Media type not supported, the request can't be processed
application/json
500
An internal error occurred, please try again later or contact the support.
application/json
post
POST /v2/users/{userId}/operations HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "externalUserId": "text",
  "operationId": "text",
  "operationPayload": "text"
}
{
  "success": true
}

Verify a signed JWT message

post

Verify a signed JWT message. The only format accepted for now is a JWT generated by a PIN signature

Authorizations
Body
messagestring · JWTRequired

The signed JWT message

Responses
200
The verification completed successfully. Check the result to see if the signature is valid or not
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
406
Not acceptable representation
application/json
415
Media type not supported, the request can't be processed
application/json
post
POST /v2/verify-jwt HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "message": "text"
}
{
  "result": true
}