Operations

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

Last updated 4 months ago

Was this helpful?

Get a user's pending operations

get

Get a user's pending operations

Authorizations

Path parameters

userIdstring · Uppercase HEX stringRequired

The user id

Responses

application/json

object[]Optional

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

application/json

objectOptional

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

application/json

objectOptional

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-----"
}

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

application/json

objectOptional

Positive feedback on the operation result

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

application/json

objectOptional

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
}