Docs
Skip to content
post

Create Account

Endpoint

posthttps://<REGION>.cloud.appwrite.io/v1/account

Description

Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the /account/verfication route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new account session.

Required scopes

public

Authentication

Initialize the Appwrite client with setProject(). No signed-in user or server API key is required.

Rate limit

Up to 10 requests per hour for each IP address calling this endpoint.
Server API key requests bypass this rate limit.

Parameters

string
Required

Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.

string
Required

User email.

string
Required

User password. Must be at least 8 chars.

string

User name. Max length: 128 chars.

Status
Content type
201
application/json

User

Name
Type
Description
string

User ID.

integer

User creation date in Unix timestamp.

integer

User update date in Unix timestamp.

string

User name.

integer

User registration date in Unix timestamp.

boolean

User status. Pass true for enabled and false for disabled.

integer

Unix timestamp of the most recent password update

string

User email address.

string

User phone number in E.164 format.

boolean

Email verification status.

boolean

Phone verification status.

object

User preferences as a key-value object Can be one of: preferences

Kotlin
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import kotlinx.coroutines.GlobalScope
import kotlinx.coroutines.launch
import io.appwrite.Client
import io.appwrite.services.Account


class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)


        val client = Client(applicationContext)
            .setEndpoint("https://[HOSTNAME_OR_IP]/v1") // Your API Endpoint
            .setProject("5df5acd0d48c2") // Your project ID


        val account = Account(client)


        GlobalScope.launch {
            val response = account.create(
                userId = "[USER_ID]",
                email = "email@example.com",
                password = "password",
            )
            val json = response.body?.string()        
        }
    }
}