Check Sign-up Email

POST

api

public

signup

checkEmail

Check Sign-up Email

curl --request POST \
  --url https://spaces.nexudus.com/api/public/signup/checkEmail \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Email": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/public/signup/checkEmail"

payload = { "Email": "<string>" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Email: '<string>'})
};

fetch('https://spaces.nexudus.com/api/public/signup/checkEmail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "MustSignIn": true
}

Tells whether signing up with an email would be refused with MUST_SIGN_IN. The email belongs to a Nexudus account, possibly in another network, so the person has to verify it before joining this location. The portal asks as soon as the email is typed and offers to send the verification link (GET /api/sys/users/restore) instead of the rest of the sign-up form. It runs the very check the sign-up runs, so the two always agree. The other refusals for an existing account (EMAIL_USED, SIGNUP_DISABLED) answer false here and are reported by the sign-up itself. It only answers yes or no: which locations the account belongs to is not disclosed.

Authentication

No authentication required. When the request is signed in as the account that owns the email, the answer is false, as the sign-up would let that person go ahead. Limited to 20 requests per minute.

Request Body

string

required

The email typed into the sign-up form. An invalid address answers false: the sign-up refuses it with INVALID_EMAIL instead.

string

The sign-in token the sign-up will be sent with (the sign-up’s Token, from the token query parameter of an invitation link). With the account owner’s own token the sign-up goes ahead, so the answer is false.

Response

true when the sign-up would be refused with MUST_SIGN_IN.

Examples

POST /api/public/signup/checkEmail
Content-Type: application/json

{
  "Email": "[email protected]"
}

{
  "MustSignIn": true
}

TypeScript Integration

The sign-up forms use useMustVerifyEmail, with the same HTTP client and token as the sign-up request:

import { useMustVerifyEmail } from '@/views/checkout/components/useMustVerifyEmail'

const mustVerifyEmail = useMustVerifyEmail(httpClient, enteredEmail, useSignupInviteLinks().token)

Check Sign-up Email

curl --request POST \
  --url https://spaces.nexudus.com/api/public/signup/checkEmail \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Email": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/public/signup/checkEmail"

payload = { "Email": "<string>" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Email: '<string>'})
};

fetch('https://spaces.nexudus.com/api/public/signup/checkEmail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "MustSignIn": true
}

Getting Started

Authentication

System

Profile

Customers & Directory

Teams

Events

Perks

Courses

Articles

Plans

Onboarding

Products & Store

Proposals

Newsletter

Checkout & Sign Up

FAQs

Help Desk

Identity Checks

Resources

Bookings

Passport

Announcements

Check-ins

Deliveries

Files

Sensors

Visitors

Community

Forms

Settings

Billing & Payments

AI

Authentication

Request Body

Response

Examples

TypeScript Integration

​Check Sign-up Email

​Authentication

​Request Body

​Response

​Examples

​TypeScript Integration

Check Sign-up Email

Authentication

Request Body

Response

Examples

TypeScript Integration