Operations

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

Last updated 2 months ago

Was this helpful?

Get a user's pending operations

get

/users/{userId}/operations/pending

Authorizations

Path parameters

userIdstring · Uppercase HEX stringrequired

The user id

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v2/users/{userId}/operations/pending' \
  --header 'X-Api-Key: YOUR_API_KEY'

200

400

401

404

406

500

[
  {
    "operationId": "123456abcdef",
    "operationPayload": "payload",
    "externalUserId": "abcdef123456",
    "authType": "biom"
  },
  {
    "operationId": "654321fedcba"
  }
]

An user's pending operations

Get a customer operation

get

/operations/{operationId}

Authorizations

Path parameters

operationIdstringrequired

Unique operation identifier set and managed by the client

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v2/operations/{operationId}' \
  --header 'X-Api-Key: YOUR_API_KEY'

200

400

401

404

406

500

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

A customer operation

Create a pending operation

post

/users/{userId}/operations

Authorizations

Path parameters

userIdstring · Uppercase HEX stringrequired

The user id

Body

externalUserIdstring

User id set and managed by the client

operationIdstringrequired

Unique operation identifier set and managed by the client

operationPayloadstring

Operation payload set and managed by the client

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v2/users/{userId}/operations' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "externalUserId": "text",
    "operationId": "text",
    "operationPayload": "text"
  }'

200

400

401

404

406

409

415

500

{
  "success": true
}

Operation created successfully

Get the customer public key

Get the customer public key in PEM format

get

/verify-jwt/public-key

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v2/verify-jwt/public-key' \
  --header 'X-Api-Key: YOUR_API_KEY'

200

400

401

406

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

The public key in PEM format

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

/verify-jwt

Authorizations

Body

messagestring · JWTrequired

The signed JWT message

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v2/verify-jwt' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "message": "text"
  }'

200

400

401

406

415

{
  "result": true
}

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