Unlock Protocol

Unlock Protocol Auth API

The Auth API from Unlock Protocol — 6 operation(s) for auth.

GitHub OpenAPI

Operations 6

GET /v2/auth/nonce #
POST /v2/auth/login #
POST /v2/auth/privy #
POST /v2/auth/logout #
POST /v2/auth/revoke #
GET /v2/auth/user #

Documentation

📖
Documentation
https://docs.unlock-protocol.com/tools/locksmith/
📖
APIReference
https://docs.unlock-protocol.com/category/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/unlock-protocol/refs/heads/main/openapi/unlock-protocol-auth-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/unlock-protocol-auth-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

unlock-protocol-auth-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Unlock Locksmith Applications Auth API
  version: '2'
  description: Locksmith provides backend functionality for enabling ticketing, metadata storage, and notification hooks.
  license:
    name: MIT
servers:
- url: https://locksmith.unlock-protocol.com
  description: Production Server
- url: https://staging-locksmith.unlock-protocol.com
  description: Staging Server
tags:
- name: Auth
paths:
  /v2/auth/nonce:
    get:
      operationId: nonce
      description: Provide a unique nonce for using in sign in with ethereum
      parameters: []
      responses:
        200:
          description: Unique nonce.
          content:
            html/text:
              schema:
                type: string
        500:
          $ref: '#/components/responses/500.InternalError'
      tags:
      - Auth
  /v2/auth/login:
    post:
      operationId: login
      description: Login as a user using Sign in with Ethereum message signed by the wallet address.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  type: string
                signature:
                  type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResult'
        400:
          $ref: '#/components/responses/400.Invalid'
        404:
          $ref: '#/components/responses/404.NotFound'
        500:
          $ref: '#/components/responses/500.InternalError'
      tags:
      - Auth
  /v2/auth/privy:
    post:
      operationId: loginWithPrivy
      description: Verify an access token using Privy's library and authenticate the user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                accessToken:
                  type: string
                  description: The Privy access token to verify
                walletAddress:
                  type: string
                  description: The wallet address from the user
              required:
              - accessToken
              - walletAddress
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResult'
        400:
          $ref: '#/components/responses/400.Invalid'
        404:
          $ref: '#/components/responses/404.NotFound'
        500:
          $ref: '#/components/responses/500.InternalError'
      tags:
      - Auth
  /v2/auth/logout:
    post:
      operationId: logout
      security:
      - User: []
      description: Logout from locksmith. This will invalidate all your session tokens.
      responses:
        200:
          $ref: '#/components/responses/200.GenericSuccess'
        500:
          $ref: '#/components/responses/500.InternalError'
      tags:
      - Auth
  /v2/auth/revoke:
    post:
      operationId: revoke
      security:
      - User: []
      description: Invalidate a session.
      responses:
        200:
          $ref: '#/components/responses/200.GenericSuccess'
        500:
          $ref: '#/components/responses/500.InternalError'
      tags:
      - Auth
  /v2/auth/user:
    get:
      operationId: user
      description: Get user details.
      security:
      - User: []
      responses:
        200:
          description: Return the user details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Auth'
        500:
          $ref: '#/components/responses/500.InternalError'
      tags:
      - Auth
components:
  responses:
    404.NotFound:
      description: The item you are making request for does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericNotFound'
    200.GenericSuccess:
      description: Successfully completed the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericSuccess'
    500.InternalError:
      description: Unable to fullfil request due to internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericServerError'
    400.Invalid:
      description: Invalid input received. Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericInvalidBodyError'
  schemas:
    GenericInvalidBodyError:
      type: object
      properties:
        message:
          type: string
          default: Response body schema is invalid.
        error:
          type:
          - string
          - 'null'
    GenericSuccess:
      type: object
      properties:
        message:
          type: string
          default: Successfully fulfilled the request.
    AuthResult:
      required:
      - accessToken
      - walletAddress
      type: object
      properties:
        walletAddress:
          type:
          - string
          - 'null'
        accessToken:
          type: string
    GenericServerError:
      type: object
      properties:
        message:
          type: string
          default: There was an error in fullfiling the request.
    GenericNotFound:
      type: object
      properties:
        message:
          type: string
          default: resource not found
    Auth:
      required:
      - walletAddress
      type: object
      properties:
        walletAddress:
          type: string
  securitySchemes:
    User:
      type: http
      scheme: bearer
      bearerFormat: JWT
    Application:
      type: apiKey
      name: api-key
      in: query