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

signInTokenstringrequired

Sign in request identifier

Header parameters

Content-Typestring · default: application/jsonrequired

application/json

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/sign-in-requests/{signInToken}/status' \
  --header 'Content-Type: application/json'

200

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

transactionTokenstringrequired

Transaction request identifier

Header parameters

Content-Typestring · default: application/jsonrequired

application/json

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/transaction-request/{transactionToken}/status' \
  --header 'Content-Type: application/json'

200

200

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

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