Skip to content
Bottle

Turn the authenticator on

POST
/storefront/sites/{host}/account/two-factor/enable
curl --request POST \
  --url https://example.com/storefront/sites/northgate.shop.getbottle.app/account/two-factor/enable \
  --header 'Content-Type: application/json' \
  --data '{ "code": "example" }'

Deliberately without a staff session: a shopper on the business’s own shop. With a code from it. Answers with ten one-use recovery codes, shown this once.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
host
required
string
Example
northgate.shop.getbottle.app

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
code
required
string
<= 10 characters
Examplegenerated
{
  "code": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

On

Media typeapplication/json
object
recoveryCodes
required
Array<string>
Examplegenerated
{
  "recoveryCodes": [
    "example"
  ]
}

400

Section titled “400”

Refused: the message says why

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not from the shop itself, or the email is not confirmed yet

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not a shop. No body.

409

Section titled “409”

Not set up, or the shop is not selling now (shop_closed)

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}

429

Section titled “429”

Too many tries

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}