CKBull Signer API
  • CKBull Signer API
  • Getting started
    • Create an account
    • Register a dApp
    • Regenerate API keys
    • Next steps
  • Guides and Concepts
    • Introduction
    • Sign in request
    • Transaction request
  • API
    • Introduction
    • Authentication
    • Transactions
    • Requests
      • Sign in request
      • Transaction request
    • Polling
Powered by GitBook
On this page
  1. API
  2. Requests

Sign in request

Sign in request API specification

PreviousRequestsNextTransaction request

Last updated 1 year ago

Generate

To create a sign in request as a dApp, call the following endpoint with the necessary parameters.

This is a protected call which uses API authentication. See how to implement it in section.

Each sign in request has 7 days to be signed or rejected before it expires.

Get

With the provided sign in token, this method will return all pertinent information from the sign in request.

🔓
API authentication
post

Create a new sign in request

Header parameters
Content-TypestringRequired

application/json

Default: application/json
x-timestampstringOptional

The timestamp of the request

x-signaturestringOptional

The signature of the request

x-api-keystringOptional

The API key of the dApp

Responses
201Success
application/json
403
Forbidden
404
DApp not found
post
POST /api/sign-in-requests HTTP/1.1
Host: 
Content-Type: text
Accept: */*

{
  "id": 1,
  "signInToken": "text",
  "status": "pending",
  "createdAt": "2025-05-09T07:49:16.261Z",
  "expiresAt": "2025-05-09T07:49:16.261Z",
  "sessionExpiresAt": "2025-05-09T07:49:16.261Z",
  "metadata": {
    "address": "text",
    "network": "mainnet"
  },
  "app": {
    "id": 1,
    "name": "text",
    "description": "text",
    "email": "text",
    "projectUrl": "text",
    "supportUrl": "text",
    "apiKey": "text",
    "termsUrl": "text",
    "privacyPolicyUrl": "text",
    "image": "text",
    "createdAt": "2025-05-09T07:49:16.261Z",
    "updatedAt": "2025-05-09T07:49:16.261Z"
  }
}
get
Path parameters
signInTokenstringRequired

Sign in request identifier

Header parameters
Content-TypestringRequired

application/json

Default: application/json
Responses
200Success
application/json
get
GET /api/sign-in-requests/{signInToken} HTTP/1.1
Host: 
Content-Type: text
Accept: */*
200Success
{
  "id": 1,
  "signInToken": "text",
  "status": "pending",
  "createdAt": "2025-05-09T07:49:16.261Z",
  "expiresAt": "2025-05-09T07:49:16.261Z",
  "sessionExpiresAt": "2025-05-09T07:49:16.261Z",
  "metadata": {
    "address": "text",
    "network": "mainnet"
  },
  "app": {
    "id": 1,
    "name": "text",
    "description": "text",
    "email": "text",
    "projectUrl": "text",
    "supportUrl": "text",
    "apiKey": "text",
    "termsUrl": "text",
    "privacyPolicyUrl": "text",
    "image": "text",
    "createdAt": "2025-05-09T07:49:16.261Z",
    "updatedAt": "2025-05-09T07:49:16.261Z"
  }
}
  • Generate
  • POST/api/sign-in-requests
  • Get
  • GET/api/sign-in-requests/{signInToken}