SCscanopy
internal

Check whether an email is available

Changed on
post/api/auth/check-email

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/auth/check-email
  • Auth
    none declared

Request body

emailstring email required

Email address to check for an existing account.

Response

Whether the address is available

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • c9d9d46d1ae8Revision changes
    • info

      api tag auth removed

  • 956b1db665ccRevision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed subschema #1 from the response property oneOf list for the response status

    • info

      added the required property / to the response with the status