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

Path parameters

signInTokenstringRequired

Sign in request identifier

Header parameters

Content-TypestringRequired

application/json

Default: application/json

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/sign-in-requests/{signInToken}/status HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*

200Success

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

Path parameters

transactionTokenstringRequired

Transaction request identifier

Header parameters

Content-TypestringRequired

application/json

Default: application/json

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /api/transaction-request/{transactionToken}/status HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*

200Success

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

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