Operations

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

Operations

Get a user's pending operations

Get a user's pending operations

GET/v2/users/{userId}/operations/pending

Path parameters

userId*string (Uppercase HEX string)

The user id

Response

200400401404406500

An user's pending operations

Body

application/json

operationId*operationId (string)

Unique operation identifier set and managed by the client

operationPayloadoperationPayload (string)

Operation payload set and managed by the client

externalUserIdexternalUserId (string)

User id set and managed by the client

authTypeenum

Authentication type of the operation

biompin

Request

JavaScriptCurlPython

const response = await fetch('/v2/users/{userId}/operations/pending', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404406500

[
  {
    "operationId": "text",
    "operationPayload": "text",
    "externalUserId": "text",
    "authType": "biom"
  }
]

Get a customer operation

Get a customer operation

GET/v2/operations/{operationId}

Path parameters

operationId*string

Unique operation identifier set and managed by the client

Response

200400401404406500

A customer operation

Body

application/json

id*number

Unique operation identifier

timestamp*string

Creation date time

nodeId*string

Name of the service that created the operation

userId*userId (string (HEX))

An HEX string representing the user id

apiKey*string

Customer SDK api key

externalUserIdexternalUserId (string)

User id set and managed by the client

operationId*operationId (string)

Unique operation identifier set and managed by the client

operationPayloadoperationPayload (string)

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

JavaScriptCurlPython

const response = await fetch('/v2/operations/{operationId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404406500

{
  "id": 0,
  "timestamp": "text",
  "nodeId": "text",
  "userId": "text",
  "apiKey": "text",
  "externalUserId": "text",
  "operationId": "text",
  "operationPayload": "text",
  "result": false,
  "authType": "biom",
  "state": "text"
}

Create a pending operation

Create a pending operation

POST/v2/users/{userId}/operations

Path parameters

userId*string (Uppercase HEX string)

The user id

Body

application/json

externalUserIdexternalUserId (string)

User id set and managed by the client

operationId*operationId (string)

Unique operation identifier set and managed by the client

operationPayloadoperationPayload (string)

Operation payload set and managed by the client

Response

200400401404406409415500

Operation created successfully

Body

application/json

success*boolean

Always true

Request

JavaScriptCurlPython

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();

Response

200400401404406409415500

{
  "success": false
}

JWT

Get the customer public key

Get the customer public key in PEM format

GET/v2/verify-jwt/public-key

Response

200400401406

The public key in PEM format

Body

application/json

content*String

PEM key representation of the customer public key

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

Request

JavaScriptCurlPython

const response = await fetch('/v2/verify-jwt/public-key', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401406

{
  "content": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwJ1\n-----END PUBLIC KEY-----"
}

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

Body

application/json

message*string (JWT)

The signed JWT message

Response

200400401406415

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

Body

application/json

result*boolean

True if the signature is valid, false otherwise

Request

JavaScriptCurlPython

const response = await fetch('/v2/verify-jwt', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "message": "text"
    }),
});
const data = await response.json();

Response

200400401406415

{
  "result": false
}