Check whether an email address has an active deletion record

POST

/api/admin/tombstones/email-check

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/tombstones/email-check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example" }'

Requires admin:users:read. Searches the current tenant’s deletion records within their retention period and audits the check. The email address is supplied only in the body. The response contains no email address, account ID, or other account attributes. A failed search or failed audit returns a server error without a deletion result.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

email

required

Email address to check; a whitespace-only string is invalid.

string

>= 1 characters <= 320 characters /\S/

Example ^generated

{
  "email": "example"
}

Responses

200

Whether an unexpired deletion record exists for the supplied address.

Media type application/json

One of:

object

object

deleted

required

boolean

key

additional properties

object

object

deleted

required

boolean

deleted_at

required

ISO 8601 timestamp when the account was deleted.

string format: date-time

retention_until

required

ISO 8601 timestamp when the deletion record’s retention ends.

string format: date-time

key

additional properties

Example

{
  "deleted": false
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}