checkEmailInUse

Public: no authentication required.

Register-flow existence probe: true when ANY account (any type — customer, staff, vendor) already occupies this email in the org, so the registration form can warn immediately instead of after a doomed OTP round-trip. Deliberately broader/more revealing than checkCustomerExists (owner-directed tradeoff for the staff-email-collision case).

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation CheckEmailInUse($input: CheckCustomerExistsInput!) {
  checkEmailInUse(input: $input) {
    exists
    selfRegistrationEnabled
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CheckEmailInUse($input: CheckCustomerExistsInput!) {\n  checkEmailInUse(input: $input) {\n    exists\n    selfRegistrationEnabled\n  }\n}",
  "variables": {
    "input": {
      "email": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "email": "string"
  }
}

Response:

{
  "data": {
    "checkEmailInUse": {
      "exists": true,
      "selfRegistrationEnabled": true
    }
  }
}

checkEmailInUse(
  input: CheckCustomerExistsInput!
): CustomerExistsResponse!

Arguments

checkEmailInUse.input ● CheckCustomerExistsInput! non-null input

The details of the check customer exists request.

Type

CustomerExistsResponse object

Whether a customer account exists.