Confirm an email address

POST

/api/auth/verify-email

curl --request POST \
  --url https://api.getvespy.com/api/auth/verify-email \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example" }'

• Production
• Development
• Local

Request Body^required

Media typeapplication/json

object

token

required

string

>= 1 characters

Example^generated

{
  "token": "example"
}

Responses

200

Default Response

Media typeapplication/json

object

user

required

object

email

required

string format: email

emailConsentAt

required

string format: date-time

nullable

emailVerifiedAt

required

string format: date-time

nullable

fullName

required

string

id

required

string format: uuid

isSuperadmin

required

boolean

organizationId

required

string format: uuid

phone

required

string

nullable

role

required

string

Allowed values: admin manager staff tenant owner vendor

smsConsentAt

required

string format: date-time

nullable

vendorId

required

string format: uuid

nullable

Example

{
  "user": {
    "role": "admin"
  }
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}