Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nhost verification API

Email and ticket verification operations for confirming user actions

Nhost verification API is one of 14 APIs that Nhost publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://{subdomain}.auth.{region}.nhost.run/v1.

2 operations 2 paths 11 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://{subdomain}.nhost.run/v1/graphql
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Nhost verification API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). It accepts HTTP bearer tokens (BearerAuthElevated).

  • BearerAuth — Bearer authentication with JWT access token. Used to authenticate requests to protected endpoints.
  • BearerAuthElevated — Bearer authentication that requires elevated permissions. Used for sensitive operations that may require additional security measures such as recent authentica…

Paths & Operations 2

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

verification 2

Email and ticket verification operations for confirming user actions

POST
/signup/webauthn/verify
Verify Webauthn sign-up
verifySignUpWebauthn body → 200default
GET
/verify
Verify email and authentication tickets
verifyTicket 3 params → 302default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are User (14 properties), CredentialCreationResponse (6 properties), AuthenticatorAttestationResponse (6 properties), SignUpOptions (6 properties). Each schema is shown below with its type and property counts.

User
object
User profile and account information
14 properties 11 required
SessionPayload
object
Container for session information
1 property
SignUpWebauthnVerifyRequest
object
3 properties 1 required
ErrorResponse
object
Standardized error response
3 properties 3 required
CredentialCreationResponse
object
6 properties 4 required
Session
object
User authentication session containing tokens and user information
5 properties 4 required
SignUpOptions
object
6 properties
URLEncodedBase64
string
Base64url-encoded binary data
CredentialPropertiesOutput
object
Credential properties extension output
1 property
AuthenticatorAttestationResponse
object
6 properties 2 required
AuthenticationExtensionsClientOutputs
object
Map of extension outputs from the client
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhost-verification-api-openapi.yml Raw ↑

Other APIs Nhost publishes across the network.

Nhost GraphQL API
Nhost Serverless Functions API
Nhost AI API
Nhost authentication API
Nhost documentation API
Nhost excludeme API
Nhost files API
Nhost operations API
Nhost security API
Nhost session API
Nhost storage API
Nhost system API