Documentation Hub
Mobile SDK
Start HereMobile SDKWeb SDKWorkforceIDV BridgeUser GuideAdmin portalWhy Keyless?
Mobile SDK
Start HereMobile SDKWeb SDKWorkforceIDV BridgeUser GuideAdmin portalWhy Keyless?
  • Keyless SDK Documentation
  • Introduction
    • 🧩Components
    • ⚙️Integration Flows
  • 📱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
  • 📱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 1 month ago

Was this helpful?

Operations

JWT

💽
  • 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

Get a user's pending operations

Get a user's pending operations

GET/v2/users/{userId}/operations/pending
Authorization
Path parameters
userId*string (Uppercase HEX string)

The user id

Response

An user's pending operations

Body
operationId*string

Unique operation identifier set and managed by the client

operationPayloadstring

Operation payload set and managed by the client

externalUserIdstring

User id set and managed by the client

authTypeenum

Authentication type of the operation

biompin
Request
Response

Get a customer operation

Get a customer operation

GET/v2/operations/{operationId}
Authorization
Path parameters
operationId*string

Unique operation identifier set and managed by the client

Response

A customer operation

Body
id*number

Unique operation identifier

timestamp*string

Creation date time

nodeId*string

Name of the service that created the operation

userId*string (HEX)

An HEX string representing the user id

apiKey*string

Customer SDK api key

externalUserIdstring

User id set and managed by the client

operationId*string

Unique operation identifier set and managed by the client

operationPayloadstring

Operation payload set and managed by the client

result*boolean

True if the operation is approved, false otherwise

authTypeenum

Authentication type of the operation

biompin
state*string

State of the operation. Possible values are 'approved' or 'pending'

Request
Response

Create a pending operation

Create a pending operation

POST/v2/users/{userId}/operations
Authorization
Path parameters
userId*string (Uppercase HEX string)

The user id

Body
externalUserIdstring

User id set and managed by the client

operationId*string

Unique operation identifier set and managed by the client

operationPayloadstring

Operation payload set and managed by the client

Response

Operation created successfully

Body
success*boolean

Always true

Request
Response

Get the customer public key

Get the customer public key in PEM format

GET/v2/verify-jwt/public-key
Authorization
Response

The public key in PEM format

Body
content*String

PEM key representation of the customer public key

Example: "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwJ1\n-----END PUBLIC KEY-----"
Request
Response

Verify a signed JWT message

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

POST/v2/verify-jwt
Authorization
Body
message*string (JWT)

The signed JWT message

Response

The verification completed successfully. Check the result to see if the signature is valid or not

Body
result*boolean

True if the signature is valid, false otherwise

Request
Response
const response = await fetch('/v2/users/{userId}/operations/pending', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
[
  {
    "operationId": "text",
    "operationPayload": "text",
    "externalUserId": "text",
    "authType": "biom"
  }
]
const response = await fetch('/v2/operations/{operationId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
{
  "id": 0,
  "timestamp": "text",
  "nodeId": "text",
  "userId": "text",
  "apiKey": "text",
  "externalUserId": "text",
  "operationId": "text",
  "operationPayload": "text",
  "result": false,
  "authType": "biom",
  "state": "text"
}
const response = await fetch('/v2/users/{userId}/operations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "operationId": "text"
    }),
});
const data = await response.json();
{
  "success": false
}
const response = await fetch('/v2/verify-jwt/public-key', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
{
  "content": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwJ1\n-----END PUBLIC KEY-----"
}
const response = await fetch('/v2/verify-jwt', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "message": "text"
    }),
});
const data = await response.json();
{
  "result": false
}