Confirm an email address

POST

/api/v1/public/email-verification

curl --request POST \
  --url https://api.deploybase.eu/api/v1/api/v1/public/email-verification \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example", "email": "sam@example.eu", "user_id": "69629026806489455" }'

Checks a sign-up code, from the link (user_id + code) or typed on the sign-up page (email + code). A typed code that fails for any reason answers one ACCOUNT_CODE_INVALID without a reason, so it cannot tell whether the address has an account. No authentication required. Limited to 10 per account and 30 per IP per hour.

Request Body

User_id or email, and the code

Media type application/json

object

code

string

email

string

Example

sam@example.eu

user_id

string

Example

69629026806489455

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

data

object

status

string

Example

{
  "data": {
    "status": "done"
  }
}

400

The code did not work (ACCOUNT_CODE_INVALID), or the request is incomplete (INVALID_INPUT)

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

details

object

reason

string

Allowed values: used expired invalid

Example

{
  "details": {
    "reason": "used"
  }
}

429

Too many attempts; see Retry-After

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

503

Temporarily unavailable

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}