1. Docs
  2. API Reference
  3. Verify email address

Verify email address

GET/v1/auth/verify-email

Public GET that confirms a signup by its token query parameter, materializing the parked PendingRegistration into the real User, Account, Free subscription, owner AccountMember, first Application, and seeded environments in one transaction, then consuming the pending row so it cannot double-materialize. Returns 400 when the token is unknown, already consumed, or expired (links are valid for 24 hours).

Query Parameters

tokenstring Required

Responses

application/json

  • dataMessageResponseDto*

Returned object

MessageResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/v1/auth/verify-email?token=value"
Response
{
  "data": {
    "message": "string"
  }
}
 Related endpoints
POSTRegister a new user
POSTCreate an additional Account for the authenticated admin (no new user)
GETReview the parked account-creation intent before resuming
POSTResume a deferred account creation parked at the register form
DELETEDismiss the parked account-creation intent without creating anything
POSTLook up invite details by token
POSTAccept an invite
POSTAuthenticate and receive tokens
POSTSelect an Account from a pre-auth session (multi-Account login)
POSTSwitch the active Application in an authenticated session
POSTRefresh access token
POSTLogout and revoke tokens
POSTResend verification email
POSTResend verification email by token
POSTRequest password reset
POSTReset password with token
POSTChange password (authenticated)
GETGet current user profile
GETGet current user avatar image
POSTUpload profile avatar
DELETERemove profile avatar
POSTRequest an email-address change
POSTConfirm an email-address change
GETGet current user permissions
GETList the Accounts the current user belongs to
GETList active sessions
DELETERevoke all sessions
DELETERevoke a specific session
 Was this page helpful?

Tell us how we can improve this guide.

Canopy