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.

Create a new sign in request

POST/api/sign-in-requests

Header parameters

Response

201403404

Body

application/json

id*number

signInToken*string

status*enum

pendingsigneddeclinedrequest_expiredsession_expired

createdAt*string (date-time)

expiresAt*string (date-time)

sessionExpiresAt*string (date-time)

metadata*AccountMetadataDto (object)

app*PartialDappDto (object)

Request

JavaScriptCurl

const response = await fetch('/api/sign-in-requests', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "id": 0,
  "signInToken": "text",
  "status": "pending",
  "createdAt": "2024-04-29T15:07:19.591Z",
  "expiresAt": "2024-04-29T15:07:19.591Z",
  "sessionExpiresAt": "2024-04-29T15:07:19.591Z",
  "metadata": {
    "address": "text",
    "network": "mainnet"
  },
  "app": {
    "id": 0,
    "name": "text",
    "description": "text",
    "email": "text",
    "projectUrl": "text",
    "supportUrl": "text",
    "apiKey": "text",
    "termsUrl": "text",
    "privacyPolicyUrl": "text",
    "image": "text",
    "createdAt": "2024-04-29T15:07:19.591Z",
    "updatedAt": "2024-04-29T15:07:19.591Z"
  }
}

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/api/sign-in-requests/{signInToken}

Path parameters

signInToken*string

Sign in request identifier

Header parameters

Response

200

Body

application/json

id*number

signInToken*string

status*enum

pendingsigneddeclinedrequest_expiredsession_expired

createdAt*string (date-time)

expiresAt*string (date-time)

sessionExpiresAt*string (date-time)

metadata*AccountMetadataDto (object)

app*PartialDappDto (object)

Request

JavaScriptCurl

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

Response

{
  "id": 0,
  "signInToken": "text",
  "status": "pending",
  "createdAt": "2024-04-29T15:07:19.591Z",
  "expiresAt": "2024-04-29T15:07:19.591Z",
  "sessionExpiresAt": "2024-04-29T15:07:19.591Z",
  "metadata": {
    "address": "text",
    "network": "mainnet"
  },
  "app": {
    "id": 0,
    "name": "text",
    "description": "text",
    "email": "text",
    "projectUrl": "text",
    "supportUrl": "text",
    "apiKey": "text",
    "termsUrl": "text",
    "privacyPolicyUrl": "text",
    "image": "text",
    "createdAt": "2024-04-29T15:07:19.591Z",
    "updatedAt": "2024-04-29T15:07:19.591Z"
  }
}