Operations

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

Operations

Get a user's pending operations

get

Get a user's pending operations

Authorizations

X-Api-Key

X-Api-KeystringRequired

The customer service api key

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

/users/{userId}/operations/pending

HTTPcURLJavaScriptPython

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

X-Api-Key

X-Api-KeystringRequired

The customer service api key

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

/operations/{operationId}

HTTPcURLJavaScriptPython

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

Create a pending operation

post

Create a pending operation

Authorizations

X-Api-Key

X-Api-KeystringRequired

The customer service api key

Path parameters

userIdstring · Uppercase HEX stringRequired

The user id

Body

application/json

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

/users/{userId}/operations

HTTPcURLJavaScriptPython

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
}

JWT

Get the customer public key

get

Get the customer public key in PEM format

Authorizations

X-Api-Key

X-Api-KeystringRequired

The customer service api key

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

/verify-jwt/public-key

HTTPcURLJavaScriptPython

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

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

X-Api-Key

X-Api-KeystringRequired

The customer service api key

Body

application/json

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

/verify-jwt

HTTPcURLJavaScriptPython

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
}