Login with a stamp

Create a session for a user through stamping client side (API key, wallet client, or passkey client).

POST

/

public

/

v1

/

submit

/

stamp_login

Authorizations

API Key

X-Stamp · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

WebAuthn (Passkey)

X-Stamp-WebAuthn · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_STAMP_LOGIN

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

The parameters object containing the specific intent data for this activity.

Show details

parameters.publicKey

string

required

Client-side public key generated by the user, which will be conditionally added to org data based on the passkey stamp associated with this request

parameters.expirationSeconds

string

Expiration window (in seconds) indicating how long the Session is valid for. If not provided, a default of 15 minutes will be used.

parameters.invalidateExisting

boolean

Invalidate all other previously generated Login API keys

generateAppProofs · boolean

Enable to have your activity generate and return App Proofs, enabling verifiability.

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.id

string

required

Unique identifier for a given Activity object.

activity.organizationId

string

required

Unique identifier for a given Organization.

activity.status

string

required

The activity status

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.stampLoginIntent

object

required

The stampLoginIntent object

Show stampLoginIntent details

activity.intent.stampLoginIntent.publicKey

string

required

Client-side public key generated by the user, which will be conditionally added to org data based on the passkey stamp associated with this request

activity.intent.stampLoginIntent.expirationSeconds

string

Expiration window (in seconds) indicating how long the Session is valid for. If not provided, a default of 15 minutes will be used.

activity.intent.stampLoginIntent.invalidateExisting

boolean

Invalidate all other previously generated Login API keys

activity.result

object

required

The result of the activity

Show result details

activity.result.stampLoginResult

object

required

The stampLoginResult object

Show stampLoginResult details

activity.result.stampLoginResult.session

string

required

Signed JWT containing an expiry, public key, session type, user id, and organization id

activity.votes

array

required

A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.

activity.fingerprint

string

required

An artifact verifying a User’s action.

activity.canApprove

boolean

required

Whether the activity can be approved.

activity.canReject

boolean

required

Whether the activity can be rejected.

activity.createdAt

string

required

The creation timestamp.

activity.updatedAt

string

required

The last update timestamp.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/stamp_login \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_STAMP_LOGIN",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "publicKey": "<string>",
        "expirationSeconds": "<string>",
        "invalidateExisting": "<boolean>"
    }
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().stampLogin({
  publicKey: "<string> (Client-side public key generated by the user, which will be conditionally added to org data based on the passkey stamp associated with this request)",
  expirationSeconds: "<string> (Expiration window (in seconds) indicating how long the Session is valid for. If not provided, a default of 15 minutes will be used.)",
  invalidateExisting: true // Invalidate all other previously generated Login API keys
});

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_STAMP_LOGIN",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "stampLoginIntent": {
            "publicKey": "<string>",
            "expirationSeconds": "<string>",
            "invalidateExisting": "<boolean>"
          }
        },
        "result": {
          "stampLoginResult": {
            "session": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}