auth

Checks the address a visitor is about to sign up with, through the pipeline registration runs.

post/api/auth/signup-preview

Request

  • Base URL: https://api.pricklymails.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pricklymails.com/api/auth/signup-preview
  • Auth: none declared

Request body

emailstring required

The address the visitor is about to sign up with.

Response

Which checks passed, and whether the address may sign up.

preview_tokenstring nullable

The handle on the stored result, to send back with POST /api/auth/register and POST /api/auth/confirm.

signup'allowed' | 'undeliverable' | 'disposable' | 'unchecked' required

Whether the previewed address may sign up.

Changes

No recorded changes to this operation across all 1 revision of this API.