com.atproto.server.createAccount

POST 
/xrpc/com.atproto.server.createAccount

This endpoint is part of the atproto PDS server and account management APIs. Requests often require authentication and are made directly to the user's own PDS instance.

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

Create an account. Implemented by PDS.

Request

application/json

Body

required

email string
handle handlerequired

Requested handle for the account.

did did

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

inviteCode string
verificationCode string
verificationPhone string
password string

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

recoveryKey string

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

plcOp

Responses

200

OK

application/json

Schema

Schema

accessJwt stringrequired
refreshJwt stringrequired
handle handlerequired
did didrequired

The DID of the new account.

didDoc

Example (from schema)

{
  "accessJwt": "string",
  "refreshJwt": "string",
  "handle": "string",
  "did": "string",
  "didDoc": {}
}

400

Bad Request

application/json

Schema

Schema

error stringrequired

Possible values: [InvalidRequest, ExpiredToken, InvalidToken, InvalidHandle, InvalidPassword, InvalidInviteCode, HandleNotAvailable, UnsupportedDomain, UnresolvableDid, IncompatibleDidDoc]

message stringrequired

Example (from schema)

{
  "error": "InvalidRequest",
  "message": "string"
}

401

Unauthorized

application/json

Schema

Schema

error required
message stringrequired

Example (from schema)

{
  "message": "string"
}

Loading...