How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Unlock Protocol Users API

The Users API from Unlock Protocol — 8 operation(s) for users.

Unlock Protocol Users API is one of 34 APIs that Unlock Protocol publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 8 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 2.

Requests are made against 2 base URLs: https://locksmith.unlock-protocol.com, https://staging-locksmith.unlock-protocol.com.

8 operations 8 paths 3 schemas 4 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2
Base URL
https://locksmith.unlock-protocol.com
Authentication
HTTP Bearer, API Key
License
MIT
Resource Areas
1

Authentication & Security 2

Unlock Protocol Users API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (User). An API key is passed in the query as api-key (Application).

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 8
POST
/v2/api/users/{emailAddress}/{selectedProvider}/waas
Gets Coinbase WAAS token for user by email and selected provider.
getWaasToken 3 params body → 200400401404500
GET
/v2/api/users/{emailAddress}/existNextAuth
Gets User account type by email.
getUserAccountType 1 param → 200400404500
GET
/v2/api/users/{emailAddress}/send-verification-code
Sends a verification code to the user's email if the current code is expired or does not exist.
sendVerificationCode 2 params → 200400500
POST
/v2/api/users/{emailAddress}/verify-email-code
Verifies the email code sent to the users email address.
verifyEmailCode 1 param body → 200400404500
PUT
/users/{emailAddress}/passwordEncryptedPrivateKey
Updates a user's private key, using their email address as key. In the case of failure a rejected promise is returned to the caller.
updateUserEncryptedPrivateKey 1 param body → 200400500
GET
/users/{emailAddress}/privatekey
Given a user's email address, retrieves their private key. In the case of failure a rejected promise is returned to the caller.
getUserPrivateKey 1 param → 200400500
GET
/users/{emailAddress}/recoveryphrase
Given a user's email address, retrieves their recovery phrase. In the case of failure a rejected promise is returned to the caller.
getUserRecoveryPhrase 1 param → 200400500
POST
/users/{publicKey}/eject
Ejects a user given their public key. In the case of failure, a rejected promise is returned to the caller.
ejectUser 1 param body → 200400401500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are GenericNotFound (1 property), NotAuthenticated (1 property), GenericServerError (1 property). Each schema is shown below with its type and property counts.

GenericServerError
object
1 property
NotAuthenticated
object
1 property
GenericNotFound
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unlock-protocol-users-api-openapi.yml Raw ↑

Other APIs Unlock Protocol publishes across the network.

Unlock Subgraphs (GraphQL)
Unlock Protocol Applications API
Unlock Protocol Auth API
Unlock Protocol Captcha API
Unlock Protocol Certificate API
Unlock Protocol Charges API
Unlock Protocol Checkout API
Unlock Protocol Claim API
Unlock Protocol Contracts API
Unlock Protocol Credit Card Details API
Unlock Protocol Email API
Unlock Protocol Email Subscriptions API
Where this information came from

This is an independent, third-party profile of Unlock Protocol Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.