Sign in request

Sign in request API specification

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 API authentication section.

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/sign-in-requests' \
  --header 'Content-Type: text'

201

403

404

201

{
  "id": 1,
  "signInToken": "text",
  "status": "pending",
  "createdAt": "2025-04-04T20:33:03.195Z",
  "expiresAt": "2025-04-04T20:33:03.195Z",
  "sessionExpiresAt": "2025-04-04T20:33:03.195Z",
  "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-04-04T20:33:03.195Z",
    "updatedAt": "2025-04-04T20:33:03.195Z"
  }
}

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.

get

Path parameters

signInTokenstringrequired

Sign in request identifier

Header parameters

Content-Typestringrequired

application/json

Default: application/json

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "id": 1,
  "signInToken": "text",
  "status": "pending",
  "createdAt": "2025-04-04T20:33:03.195Z",
  "expiresAt": "2025-04-04T20:33:03.195Z",
  "sessionExpiresAt": "2025-04-04T20:33:03.195Z",
  "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-04-04T20:33:03.195Z",
    "updatedAt": "2025-04-04T20:33:03.195Z"
  }
}