signup

Verify email with OTP code

Submit the 6-digit OTP sent to the email supplied during signup. On success the workspace is marked as email-verified and the OTP is consumed. After 5 wrong guesses the code is invalidated and a new signup call is required to obtain a fresh one.

post/v1/signup/verify

Request

Base URL: https://api.framelane.io
URL: https://api.framelane.io/v1/signup/verify
Auth: none declared

Request body

emailstring email required

The email address used during signup.

otp_codestring required

The 6-digit OTP sent to the email.

Example request

{
  "email": "dev@acmecorp.com",
  "otp_code": "123456"
}

Response

Successful Response

idstring required

Unique workspace ID.

namestring required

Display name for the workspace.

emailstring nullable

Contact email for the workspace owner.

email_verifiedboolean

Whether the email address has been verified via OTP.

plan'free' | 'pro' | 'enterprise'

plan_status'active' | 'past_due' | 'cancelled' | 'trialing'

created_atstring date-time required

ISO-8601 UTC timestamp when the workspace was created.

is_adminboolean

Whether this is an admin workspace, which curates the public template gallery (POST, PATCH and DELETE /v1/templates) and sees its draft listings.

Example response

{
  "id": "ws_01J8QR2K5VKDGN2T4FBM3CZYX8",
  "name": "Acme Corp",
  "email": "dev@acmecorp.com"
}

Changes

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