Polling

Requests status polling

As a dApp, you may want to check the status of a certain request in order to adapt your frontend. To achieve this, CKBull Signer API has two prepared endpoints to obtain the status of a request.

Sign in request polling

A simple endpoint to obtain the status of a sign in request by its token.

GET/api/sign-in-requests/{signInToken}/status

Path parameters

signInToken*string

Sign in request identifier

Header parameters

Response

200

Body

application/json

signInToken*string

status*enum

pendingsigneddeclinedrequest_expiredsession_expired

Request

JavaScriptCurlPython

const response = await fetch('/api/sign-in-requests/{signInToken}/status', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "signInToken": "text",
  "status": "pending"
}

As mentioned in Guides and concepts, a sign in request can have the following status: pending, expired, signed, declined or session expired.

Transaction request polling

A simple endpoint to obtain the status of a transaction request by its token.

GET/api/transaction-request/{transactionToken}/status

Path parameters

transactionToken*string

Transaction request identifier

Header parameters

Response

200

Body

application/json

transactionToken*string

status*enum

pendingsignedexpireddeclined

Request

JavaScriptCurlPython

const response = await fetch('/api/transaction-request/{transactionToken}/status', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "transactionToken": "text",
  "status": "pending"
}

As mentioned in Guides and concepts, a sign in request can have the following status: pending, expired, signed, declined.