Backfill in-progress. Some lexicons and records may be missing or incomplete.

com.atproto.server.createAccount

atproto-lexicons.bsky.social

Documentation

main procedure

Create an account. Implemented by PDS.

Input

Encodingapplication/json
did stringdid Optional

Pre-existing atproto DID, being imported to a new account.

email string Optional

No description provided.

handle stringhandle Required

Requested handle for the account.

inviteCode string Optional

No description provided.

password string Optional

Initial account password. May need to meet instance-specific password strength requirements.

plcOp unknown Optional

A signed DID PLC operation to be submitted as part of importing an existing account to this instance. NOTE: this optional field may be updated when full account migration is implemented.

recoveryKey string Optional

DID PLC rotation key (aka, recovery key) to be included in PLC creation operation.

verificationCode string Optional

No description provided.

verificationPhone string Optional

No description provided.

Output

Encodingapplication/json
accessJwt string Required

No description provided.

did stringdid Required

The DID of the new account.

didDoc unknown Optional

Complete DID document.

handle stringhandle Required

An AT Protocol handle (e.g., alice.bsky.social).

refreshJwt string Required

No description provided.

Errors

InvalidHandle
InvalidPassword
InvalidInviteCode
HandleNotAvailable
UnsupportedDomain
UnresolvableDid
IncompatibleDidDoc
Try It

Direct PDS XRPC methods (com.atproto.*) are disabled in Try It for security reasons.

These methods interact directly with Personal Data Servers and require careful handling. Use a dedicated client or CLI tool instead.
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "handle"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "Pre-existing atproto DID, being imported to a new account."
        },
        "email": {
          "type": "string"
        },
        "plcOp": {
          "type": "unknown",
          "description": "A signed DID PLC operation to be submitted as part of importing an existing account to this instance. NOTE: this optional field may be updated when full account migration is implemented."
        },
        "handle": {
          "type": "string",
          "format": "handle",
          "description": "Requested handle for the account."
        },
        "password": {
          "type": "string",
          "description": "Initial account password. May need to meet instance-specific password strength requirements."
        },
        "inviteCode": {
          "type": "string"
        },
        "recoveryKey": {
          "type": "string",
          "description": "DID PLC rotation key (aka, recovery key) to be included in PLC creation operation."
        },
        "verificationCode": {
          "type": "string"
        },
        "verificationPhone": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "InvalidHandle"
    },
    {
      "name": "InvalidPassword"
    },
    {
      "name": "InvalidInviteCode"
    },
    {
      "name": "HandleNotAvailable"
    },
    {
      "name": "UnsupportedDomain"
    },
    {
      "name": "UnresolvableDid"
    },
    {
      "name": "IncompatibleDidDoc"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "accessJwt",
        "refreshJwt",
        "handle",
        "did"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did",
          "description": "The DID of the new account."
        },
        "didDoc": {
          "type": "unknown",
          "description": "Complete DID document."
        },
        "handle": {
          "type": "string",
          "format": "handle"
        },
        "accessJwt": {
          "type": "string"
        },
        "refreshJwt": {
          "type": "string"
        }
      },
      "description": "Account login session returned on successful account creation."
    },
    "encoding": "application/json"
  },
  "description": "Create an account. Implemented by PDS."
}

Lexicon Garden

@