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-TypestringRequiredDefault:
application/json
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: application/json
Accept: */*
{
"id": 1,
"signInToken": "text",
"status": "pending",
"createdAt": "2025-07-01T00:22:31.333Z",
"expiresAt": "2025-07-01T00:22:31.333Z",
"sessionExpiresAt": "2025-07-01T00:22:31.333Z",
"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-07-01T00:22:31.333Z",
"updatedAt": "2025-07-01T00:22:31.333Z"
}
}
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-TypestringRequiredDefault:
application/json
application/json
Responses
200Success
application/json
get
GET /api/sign-in-requests/{signInToken} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
200Success
{
"id": 1,
"signInToken": "text",
"status": "pending",
"createdAt": "2025-07-01T00:22:31.333Z",
"expiresAt": "2025-07-01T00:22:31.333Z",
"sessionExpiresAt": "2025-07-01T00:22:31.333Z",
"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-07-01T00:22:31.333Z",
"updatedAt": "2025-07-01T00:22:31.333Z"
}
}
Last updated