Operations
This set of API calls allows you to fetch operations on various Keyless entities.
Operations
Get a user's pending operations
The user id
An user's pending operations
Request is invalid and shouldn't be retried if the request is unchanged
Unauthorized request, the request can't be processed unless you provide a valid authentication method
Resource not found
Not acceptable representation
An internal error occurred, please try again later or contact the support.
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
Unique operation identifier set and managed by the client
A customer operation
Request is invalid and shouldn't be retried if the request is unchanged
Unauthorized request, the request can't be processed unless you provide a valid authentication method
Resource not found
Not acceptable representation
An internal error occurred, please try again later or contact the support.
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
The user id
User id set and managed by the client
Unique operation identifier set and managed by the client
Operation payload set and managed by the client
Operation created successfully
Request is invalid and shouldn't be retried if the request is unchanged
Unauthorized request, the request can't be processed unless you provide a valid authentication method
Resource not found
Not acceptable representation
The requested operation conflicts with the current state of the server
Media type not supported, the request can't be processed
An internal error occurred, please try again later or contact the support.
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 in PEM format
The public key in PEM format
Request is invalid and shouldn't be retried if the request is unchanged
Unauthorized request, the request can't be processed unless you provide a valid authentication method
Not acceptable representation
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. The only format accepted for now is a JWT generated by a PIN signature
The signed JWT message
The verification completed successfully. Check the result to see if the signature is valid or not
Request is invalid and shouldn't be retried if the request is unchanged
Unauthorized request, the request can't be processed unless you provide a valid authentication method
Not acceptable representation
Media type not supported, the request can't be processed
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
}Last updated
Was this helpful?